fix(deps): update dependency com.charleskorn.kaml:kaml to v0.74.0 (#715)

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

.envrc

@@ -0,0 +1,10 @@
+if ! has nix_direnv_version || ! nix_direnv_version 3.0.5; then
+  source_url "https://raw.githubusercontent.com/nix-community/nix-direnv/3.0.5/direnvrc" "sha256-zelF0vLbEl5uaqrfIzbgNzJWGmLzCmYAkInj/LNxvKs="
+fi
+
+watch_file flake.nix
+watch_file flake.lock
+if ! use flake . --impure
+then
+  echo "Flake could not be used... something is broken :(" >&2
+fi

.github/ISSUE_TEMPLATE/documentation.md

@@ -0,0 +1,17 @@
+---
+name: Documentation
+about: Suggest an improvement to the documentation for Kompendium
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Please describe the problem with the current documentation.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Link any docs references**
+Link to existing docs if incorrect, or references from another project if you have an example.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/pr_checks.yml

@@ -4,28 +4,28 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
-      - name: Set up JDK 17
+      - name: Set up JDK 21
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4
         with:
           distribution: 'adopt'
-          java-version: '17'
+          java-version: '21'
       - name: Lint
-        uses: burrunan/gradle-cache-action@v1
+        uses: burrunan/gradle-cache-action@v2
         with:
           gradle-version: wrapper
           arguments: detekt
   unit:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
-      - name: Set up JDK 17
+      - name: Set up JDK 21
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4
         with:
           distribution: 'adopt'
-          java-version: '17'
+          java-version: '21'
       - name: Unit Tests
-        uses: burrunan/gradle-cache-action@v1
+        uses: burrunan/gradle-cache-action@v2
         with:
           gradle-version: wrapper
-          arguments: test koverMergedReport
+          arguments: test koverHtmlReport

.github/workflows/publish.yml

@@ -1,25 +0,0 @@
-name: Publish to GitHub Packages
-on:
-  push:
-    branches: [ main ]
-    paths-ignore:
-      - docs/**
-env:
-  ORG_GRADLE_PROJECT_signingKey: ${{ secrets.SONATYPE_SIGNING_KEY }}
-  ORG_GRADLE_PROJECT_signingPassword: ${{ secrets.SONATYPE_SIGNING_PASSWORD }}
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-java@v3
-        with:
-          distribution: 'adopt'
-          java-version: '17'
-      - name: Publish to GitHub Packages
-        uses: burrunan/gradle-cache-action@v1
-        with:
-          gradle-version: wrapper
-          arguments: publishAllPublicationsToGithubPackagesRepository
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release.yml

@@ -4,25 +4,26 @@ on:
     types:
       - prereleased
       - released
-env:
-  ORG_GRADLE_PROJECT_signingKey: ${{ secrets.SONATYPE_SIGNING_KEY }}
-  ORG_GRADLE_PROJECT_signingPassword: ${{ secrets.SONATYPE_SIGNING_PASSWORD }}
 jobs:
-  publish-to-nexus:
+  publish-to-maven-central:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
-      - uses: actions/setup-java@v3
+      - uses: actions/setup-java@v4
         with:
           distribution: 'adopt'
-          java-version: '17'
+          java-version: '21'
       - name: Publish to Maven Central
-        uses: burrunan/gradle-cache-action@v1
+        uses: burrunan/gradle-cache-action@v2
         with:
           gradle-version: wrapper
-          arguments: publishToSonatype closeAndReleaseSonatypeStagingRepository
+          arguments: publishAndReleaseToMavenCentral --no-configuration-cache --stacktrace
           properties: |
             release=true
         env:
-          ORG_GRADLE_PROJECT_sonatypeUsername: ${{ secrets.SONATYPE_USER }}
+          ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.MAVEN_CENTRAL_USERNAME }}
-          ORG_GRADLE_PROJECT_sonatypePassword: ${{ secrets.SONATYPE_PASSWORD }}
+          ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.MAVEN_CENTRAL_PASSWORD }}
+          ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.MAVEN_SIGNING_KEY }}
+          # NOTE: FML https://stackoverflow.com/a/39573795
+          ORG_GRADLE_PROJECT_signingInMemoryKeyId: FF618132
+          ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.MAVEN_SIGNING_PASSWORD }}

.gitignore

@@ -1,3 +1,4 @@
 .gradle
 build
 .idea
+.direnv

README.md

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

build.gradle.kts

@@ -1,21 +1,19 @@
+import com.vanniktech.maven.publish.SonatypeHost
+import io.bkbn.sourdough.gradle.library.jvm.LibraryJvmPlugin
+import io.bkbn.sourdough.gradle.library.jvm.LibraryJvmExtension
+
 plugins {
-  kotlin("jvm") version "1.8.10" apply false
+  kotlin("jvm") version "2.1.20" apply false
-  kotlin("plugin.serialization") version "1.8.10" apply false
+  kotlin("plugin.serialization") version "2.1.20" apply false
-  id("io.bkbn.sourdough.library.jvm") version "0.12.0" apply false
+  id("io.bkbn.sourdough.library.jvm") version "0.13.1" apply false
-  id("io.bkbn.sourdough.application.jvm") version "0.12.0" apply false
+  id("io.bkbn.sourdough.application.jvm") version "0.13.1" apply false
-  id("io.bkbn.sourdough.root") version "0.12.0"
+  id("com.vanniktech.maven.publish") version "0.31.0" apply false
-  id("com.github.jakemarsden.git-hooks") version "0.0.2"
+  id("io.bkbn.sourdough.root") version "0.13.1"
-  id("org.jetbrains.kotlinx.kover") version "0.6.1"
+  id("org.jetbrains.kotlinx.kover") version "0.9.1"
-  id("io.github.gradle-nexus.publish-plugin") version "1.2.0"
 }
 
-gitHooks {
+dependencies {
-  setHooks(
+  subprojects.forEach { kover(it) }
-    mapOf(
-      "pre-commit" to "detekt",
-      "pre-push" to "test"
-    )
-  )
 }
 
 allprojects {
@@ -31,15 +29,16 @@ allprojects {
 }
 
 subprojects {
-  plugins.withType(io.bkbn.sourdough.gradle.library.jvm.LibraryJvmPlugin::class) {
+  plugins.withType(LibraryJvmPlugin::class) {
-    extensions.configure(io.bkbn.sourdough.gradle.library.jvm.LibraryJvmExtension::class) {
+    extensions.configure(LibraryJvmExtension::class) {
       githubOrg.set("bkbnio")
       githubRepo.set("kompendium")
       licenseName.set("MIT License")
       licenseUrl.set("https://mit-license.org")
-      developerId.set("unredundant")
+      developerId.set("brizzbuzz")
       developerName.set("Ryan Brink")
       developerEmail.set("admin@bkbn.io")
+      sonatypeHost.set(SonatypeHost.CENTRAL_PORTAL)
     }
   }
 }

core/build.gradle.kts

@@ -4,7 +4,7 @@ plugins {
   id("io.bkbn.sourdough.library.jvm")
   id("io.gitlab.arturbosch.detekt")
   id("com.adarshr.test-logger")
-  id("maven-publish")
+  id("com.vanniktech.maven.publish")
   id("java-library")
   id("signing")
   id("java-test-fixtures")
@@ -20,6 +20,7 @@ sourdoughLibrary {
 dependencies {
   // VERSIONS
   val kotestVersion: String by project
+  val kotlinSerializeVersion: String by project
   val ktorVersion: String by project
   val detektVersion: String by project
 
@@ -43,13 +44,11 @@ dependencies {
   testFixturesApi("io.kotest:kotest-assertions-core-jvm:$kotestVersion")
   testFixturesApi("io.kotest:kotest-property-jvm:$kotestVersion")
   testFixturesApi("io.kotest:kotest-assertions-json-jvm:$kotestVersion")
-  testFixturesApi("io.kotest:kotest-assertions-ktor-jvm:4.4.3")
+  testFixturesApi("io.kotest.extensions:kotest-assertions-ktor:2.0.0")
 
   testFixturesApi("io.ktor:ktor-server-core:$ktorVersion")
   testFixturesApi("io.ktor:ktor-server-test-host:$ktorVersion")
   testFixturesApi("io.ktor:ktor-serialization:$ktorVersion")
-  testFixturesApi("io.ktor:ktor-serialization-jackson:$ktorVersion")
-  testFixturesApi("io.ktor:ktor-serialization-gson:$ktorVersion")
   testFixturesApi("io.ktor:ktor-serialization-kotlinx-json:$ktorVersion")
   testFixturesApi("io.ktor:ktor-server-content-negotiation:$ktorVersion")
   testFixturesApi("io.ktor:ktor-server-auth:$ktorVersion")
@@ -57,9 +56,9 @@ dependencies {
   testFixturesApi("io.ktor:ktor-client:$ktorVersion")
   testFixturesApi("io.ktor:ktor-client-cio:$ktorVersion")
 
-  testFixturesApi("dev.forst:ktor-api-key:2.2.2")
+  testFixturesApi("dev.forst:ktor-api-key:2.2.4")
 
-  testFixturesApi("org.jetbrains.kotlinx:kotlinx-serialization-json:1.4.1")
+  testFixturesApi("org.jetbrains.kotlinx:kotlinx-serialization-json:$kotlinSerializeVersion")
 }
 
 testing {

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

@@ -10,6 +10,7 @@ class DeleteInfo private constructor(
   override val summary: String,
   override val description: String,
   override val externalDocumentation: ExternalDocumentation?,
+  override val security: Map<String, List<String>>?,
   override val operationId: String?,
   override val deprecated: Boolean,
   override val parameters: List<Parameter>
@@ -33,7 +34,8 @@ class DeleteInfo private constructor(
       externalDocumentation = externalDocumentation,
       operationId = operationId,
       deprecated = deprecated,
-      parameters = parameters
+      parameters = parameters,
+      security = security
     )
   }
 }

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

@@ -12,7 +12,8 @@ class GetInfo private constructor(
   override val externalDocumentation: ExternalDocumentation?,
   override val operationId: String?,
   override val deprecated: Boolean,
-  override val parameters: List<Parameter>
+  override val parameters: List<Parameter>,
+  override val security: Map<String, List<String>>?
 ) : MethodInfo {
 
   companion object {
@@ -33,7 +34,8 @@ class GetInfo private constructor(
       externalDocumentation = externalDocumentation,
       operationId = operationId,
       deprecated = deprecated,
-      parameters = parameters
+      parameters = parameters,
+      security = security
     )
   }
 }

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

@@ -12,7 +12,8 @@ class HeadInfo private constructor(
   override val externalDocumentation: ExternalDocumentation?,
   override val operationId: String?,
   override val deprecated: Boolean,
-  override val parameters: List<Parameter>
+  override val parameters: List<Parameter>,
+  override val security: Map<String, List<String>>?,
 ) : MethodInfo {
 
   companion object {
@@ -33,7 +34,8 @@ class HeadInfo private constructor(
       externalDocumentation = externalDocumentation,
       operationId = operationId,
       deprecated = deprecated,
-      parameters = parameters
+      parameters = parameters,
+      security = security,
     )
   }
 }

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

@@ -9,6 +9,9 @@ sealed interface MethodInfo {
   val tags: Set<String>
   val summary: String
   val description: String
+
+  val security: Map<String, List<String>>?
+    get() = null
   val externalDocumentation: ExternalDocumentation?
     get() = null
   val operationId: String?
@@ -28,6 +31,7 @@ sealed interface MethodInfo {
     internal var tags: Set<String> = emptySet()
     internal var parameters: List<Parameter> = emptyList()
     internal var errors: MutableList<ResponseInfo> = mutableListOf()
+    internal var security: Map<String, List<String>>? = null
 
     fun response(init: ResponseInfo.Builder.() -> Unit) = apply {
       val builder = ResponseInfo.Builder()
@@ -59,6 +63,8 @@ sealed interface MethodInfo {
 
     fun parameters(vararg parameters: Parameter) = apply { this.parameters = parameters.toList() }
 
+    fun security(security: Map<String, List<String>>) = apply { this.security = security }
+
     abstract fun build(): T
   }
 }

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/OptionsInfo.kt

@@ -12,7 +12,8 @@ class OptionsInfo private constructor(
   override val externalDocumentation: ExternalDocumentation?,
   override val operationId: String?,
   override val deprecated: Boolean,
-  override val parameters: List<Parameter>
+  override val parameters: List<Parameter>,
+  override val security: Map<String, List<String>>?,
 ) : MethodInfo {
 
   companion object {
@@ -33,7 +34,8 @@ class OptionsInfo private constructor(
       externalDocumentation = externalDocumentation,
       operationId = operationId,
       deprecated = deprecated,
-      parameters = parameters
+      parameters = parameters,
+      security = security,
     )
   }
 }

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>,
@@ -13,7 +13,8 @@ class PatchInfo private constructor(
   override val externalDocumentation: ExternalDocumentation?,
   override val operationId: String?,
   override val deprecated: Boolean,
-  override val parameters: List<Parameter>
+  override val parameters: List<Parameter>,
+  override val security: Map<String, List<String>>?,
 ) : MethodInfoWithRequest {
 
   companion object {
@@ -26,7 +27,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,
@@ -35,7 +36,8 @@ class PatchInfo private constructor(
       externalDocumentation = externalDocumentation,
       operationId = operationId,
       deprecated = deprecated,
-      parameters = parameters
+      parameters = parameters,
+      security = security,
     )
   }
 }

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>,
@@ -13,7 +13,8 @@ class PostInfo private constructor(
   override val externalDocumentation: ExternalDocumentation?,
   override val operationId: String?,
   override val deprecated: Boolean,
-  override val parameters: List<Parameter>
+  override val parameters: List<Parameter>,
+  override val security: Map<String, List<String>>?,
 ) : MethodInfoWithRequest {
 
   companion object {
@@ -26,7 +27,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,
@@ -35,7 +36,8 @@ class PostInfo private constructor(
       externalDocumentation = externalDocumentation,
       operationId = operationId,
       deprecated = deprecated,
-      parameters = parameters
+      parameters = parameters,
+      security = security,
     )
   }
 }

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>,
@@ -13,7 +13,8 @@ class PutInfo private constructor(
   override val externalDocumentation: ExternalDocumentation?,
   override val operationId: String?,
   override val deprecated: Boolean,
-  override val parameters: List<Parameter>
+  override val parameters: List<Parameter>,
+  override val security: Map<String, List<String>>?,
 ) : MethodInfoWithRequest {
 
   companion object {
@@ -26,7 +27,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,
@@ -35,7 +36,8 @@ class PutInfo private constructor(
       externalDocumentation = externalDocumentation,
       operationId = operationId,
       deprecated = deprecated,
-      parameters = parameters
+      parameters = parameters,
+      security = security,
     )
   }
 }

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

@@ -7,10 +7,11 @@ import kotlin.reflect.typeOf
 
 class RequestInfo private constructor(
   val requestType: KType,
-  val typeEnrichment: TypeEnrichment<*>?,
+  val enrichment: TypeEnrichment<*>?,
   val description: String,
   val examples: Map<String, MediaType.Example>?,
-  val mediaTypes: Set<String>
+  val mediaTypes: Set<String>,
+  val required: Boolean
 ) {
 
   companion object {
@@ -27,6 +28,11 @@ class RequestInfo private constructor(
     private var description: String? = null
     private var examples: Map<String, MediaType.Example>? = null
     private var mediaTypes: Set<String>? = null
+    private var required: Boolean? = null
+
+    fun required(r: Boolean) = apply {
+      this.required = r
+    }
 
     fun requestType(t: KType) = apply {
       this.requestType = t
@@ -43,8 +49,8 @@ class RequestInfo private constructor(
 
     fun description(s: String) = apply { this.description = s }
 
-    fun examples(vararg e: Pair<String, Any>) = apply {
+    fun examples(vararg e: Pair<String, MediaType.Example>) = apply {
-      this.examples = e.toMap().mapValues { (_, v) -> MediaType.Example(v) }
+      this.examples = e.toMap()
     }
 
     fun mediaTypes(vararg m: String) = apply {
@@ -54,9 +60,10 @@ class RequestInfo private constructor(
     fun build() = RequestInfo(
       requestType = requestType ?: error("Request type must be present"),
       description = description ?: error("Description must be present"),
-      typeEnrichment = typeEnrichment,
+      enrichment = typeEnrichment,
       examples = examples,
-      mediaTypes = mediaTypes ?: setOf("application/json")
+      mediaTypes = mediaTypes ?: setOf("application/json"),
+      required = required ?: true
     )
   }
 }

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

@@ -1,6 +1,7 @@
 package io.bkbn.kompendium.core.metadata
 
 import io.bkbn.kompendium.enrichment.TypeEnrichment
+import io.bkbn.kompendium.oas.payload.Header
 import io.bkbn.kompendium.oas.payload.MediaType
 import io.ktor.http.HttpStatusCode
 import kotlin.reflect.KType
@@ -9,10 +10,11 @@ import kotlin.reflect.typeOf
 class ResponseInfo private constructor(
   val responseCode: HttpStatusCode,
   val responseType: KType,
-  val typeEnrichment: TypeEnrichment<*>?,
+  val enrichment: TypeEnrichment<*>?,
   val description: String,
   val examples: Map<String, MediaType.Example>?,
-  val mediaTypes: Set<String>
+  val mediaTypes: Set<String>,
+  val responseHeaders: Map<String, Header>?
 ) {
 
   companion object {
@@ -30,6 +32,11 @@ class ResponseInfo private constructor(
     private var description: String? = null
     private var examples: Map<String, MediaType.Example>? = null
     private var mediaTypes: Set<String>? = null
+    private var responseHeaders: Map<String, Header>? = null
+
+    fun responseHeaders(headers: Map<String, Header>) = apply {
+      this.responseHeaders = headers
+    }
 
     fun responseCode(code: HttpStatusCode) = apply {
       this.responseCode = code
@@ -50,8 +57,8 @@ class ResponseInfo private constructor(
 
     fun description(s: String) = apply { this.description = s }
 
-    fun examples(vararg e: Pair<String, Any>) = apply {
+    fun examples(vararg e: Pair<String, MediaType.Example>) = apply {
-      this.examples = e.toMap().mapValues { (_, v) -> MediaType.Example(v) }
+      this.examples = e.toMap()
     }
 
     fun mediaTypes(vararg m: String) = apply {
@@ -62,9 +69,10 @@ class ResponseInfo private constructor(
       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!"),
-      typeEnrichment = typeEnrichment,
+      enrichment = typeEnrichment,
       examples = examples,
-      mediaTypes = mediaTypes ?: setOf("application/json")
+      mediaTypes = mediaTypes ?: setOf("application/json"),
+      responseHeaders = responseHeaders
     )
   }
 }

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

@@ -1,16 +1,14 @@
 package io.bkbn.kompendium.core.plugin
 
 import io.bkbn.kompendium.core.attribute.KompendiumAttributes
+import io.bkbn.kompendium.json.schema.KotlinXSchemaConfigurator
 import io.bkbn.kompendium.json.schema.SchemaConfigurator
 import io.bkbn.kompendium.json.schema.definition.JsonSchema
 import io.bkbn.kompendium.json.schema.util.Helpers.getSimpleSlug
 import io.bkbn.kompendium.oas.OpenApiSpec
-import io.ktor.http.HttpStatusCode
-import io.ktor.server.application.call
 import io.ktor.server.application.createApplicationPlugin
 import io.ktor.server.response.respond
 import io.ktor.server.routing.Routing
-import io.ktor.server.routing.application
 import io.ktor.server.routing.get
 import io.ktor.server.routing.route
 import io.ktor.server.routing.routing
@@ -19,25 +17,26 @@ import kotlin.reflect.KType
 object NotarizedApplication {
 
   class Config {
-    lateinit var spec: OpenApiSpec
+    lateinit var spec: () -> OpenApiSpec
-    var openApiJson: Routing.() -> Unit = {
+    var specRoute: (OpenApiSpec, Routing) -> Unit = { spec, routing ->
-      route("/openapi.json") {
+      routing.route("/openapi.json") {
         get {
-          call.respond(HttpStatusCode.OK, this@route.application.attributes[KompendiumAttributes.openApiSpec])
+          call.respond(spec)
         }
       }
     }
     var customTypes: Map<KType, JsonSchema> = emptyMap()
-    var schemaConfigurator: SchemaConfigurator = SchemaConfigurator.Default()
+    var schemaConfigurator: SchemaConfigurator = KotlinXSchemaConfigurator()
   }
 
   operator fun invoke() = createApplicationPlugin(
     name = "NotarizedApplication",
     createConfiguration = ::Config
   ) {
-    val spec = pluginConfig.spec
+    val spec = pluginConfig.spec()
-    val routing = application.routing { }
+    val routing = application.routing {}
-    pluginConfig.openApiJson(routing)
+    this@createApplicationPlugin.pluginConfig.specRoute(spec, routing)
+    // pluginConfig.openApiJson(routing)
     pluginConfig.customTypes.forEach { (type, schema) ->
       spec.components.schemas[type.getSimpleSlug()] = schema
     }

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

@@ -78,7 +78,7 @@ object NotarizedRoute {
 
   fun Route.calculateRoutePath() = toString()
     .let {
-      application.environment.rootPath.takeIf { root -> root.isNotEmpty() }
+      application.rootPath.takeIf { root -> root.isNotEmpty() }
         ?.let { root ->
           val sanitizedRoute = if (root.startsWith("/")) root else "/$root"
           it.replace(sanitizedRoute, "")
@@ -86,6 +86,7 @@ object NotarizedRoute {
         ?: it
     }
     .replace(Regex("/\\(.+\\)"), "")
+    .replace(Regex("/\\[.+\\]"), "")
 
   fun Route.collectAuthMethods() = toString()
     .split("/")

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

@@ -42,6 +42,7 @@ object Helpers {
     }
   }
 
+  @Suppress("CyclomaticComplexMethod")
   fun MethodInfo.addToSpec(
     path: Path,
     spec: OpenApiSpec,
@@ -50,35 +51,46 @@ object Helpers {
     routePath: String,
     authMethods: List<String> = emptyList()
   ) {
+    val type = this.response.responseType
+    val enrichment = this.response.enrichment
     SchemaGenerator.fromTypeOrUnit(
-      type = this.response.responseType,
+      type = type,
       cache = spec.components.schemas,
       schemaConfigurator = schemaConfigurator,
-      enrichment = this.response.typeEnrichment,
+      enrichment = enrichment,
     )?.let { schema ->
-      spec.components.schemas[this.response.responseType.getSlug(this.response.typeEnrichment)] = schema
+      val slug = type.getSlug(enrichment)
+      spec.components.schemas[slug] = schema
     }
 
     errors.forEach { error ->
+      val errorEnrichment = error.enrichment
+      val errorType = error.responseType
       SchemaGenerator.fromTypeOrUnit(
-        type = error.responseType,
+        type = errorType,
         cache = spec.components.schemas,
         schemaConfigurator = schemaConfigurator,
-        enrichment = error.typeEnrichment,
+        enrichment = errorEnrichment,
       )?.let { schema ->
-        spec.components.schemas[error.responseType.getSlug(error.typeEnrichment)] = schema
+        val slug = errorType.getSlug(errorEnrichment)
+        spec.components.schemas[slug] = schema
       }
     }
 
     when (this) {
       is MethodInfoWithRequest -> {
-        SchemaGenerator.fromTypeOrUnit(
+        this.request?.let { reqInfo ->
-          type = this.request.requestType,
+          val reqEnrichment = reqInfo.enrichment
-          cache = spec.components.schemas,
+          val reqType = reqInfo.requestType
-          schemaConfigurator = schemaConfigurator,
+          SchemaGenerator.fromTypeOrUnit(
-          enrichment = this.request.typeEnrichment,
+            type = reqType,
-        )?.let { schema ->
+            cache = spec.components.schemas,
-          spec.components.schemas[this.request.requestType.getSlug(this.request.typeEnrichment)] = schema
+            schemaConfigurator = schemaConfigurator,
+            enrichment = reqEnrichment,
+          )?.let { schema ->
+            val slug = reqType.getSlug(reqEnrichment)
+            spec.components.schemas[slug] = schema
+          }
         }
       }
 
@@ -116,42 +128,62 @@ object Helpers {
     operationId = this.operationId,
     deprecated = this.deprecated,
     parameters = this.parameters,
-    security = config.security
+    security = this.createCombinedSecurityContext(config),
-      ?.map { (k, v) -> k to v }
-      ?.map { listOf(it).toMap() }
-      ?.toMutableList(),
     requestBody = when (this) {
-      is MethodInfoWithRequest -> Request(
+      is MethodInfoWithRequest -> this.request?.let { reqInfo ->
-        description = this.request.description,
+        Request(
-        content = this.request.requestType.toReferenceContent(
+          description = reqInfo.description,
-          examples = this.request.examples,
+          content = reqInfo.requestType.toReferenceContent(
-          mediaTypes = this.request.mediaTypes,
+            examples = reqInfo.examples,
-          enrichment = this.request.typeEnrichment
+            mediaTypes = reqInfo.mediaTypes,
-        ),
+            enrichment = reqInfo.enrichment
-        required = true
+          ),
-      )
+          required = reqInfo.required
+        )
+      }
 
       else -> null
     },
     responses = mapOf(
       this.response.responseCode.value to Response(
         description = this.response.description,
+        headers = this.response.responseHeaders,
         content = this.response.responseType.toReferenceContent(
           examples = this.response.examples,
           mediaTypes = this.response.mediaTypes,
-          enrichment = this.response.typeEnrichment
+          enrichment = this.response.enrichment
         )
       )
     ).plus(this.errors.toResponseMap())
   )
 
+  private fun MethodInfo.createCombinedSecurityContext(config: SpecConfig): MutableList<Map<String, List<String>>>? {
+    val configSecurity = config.security
+      ?.map { (k, v) -> k to v }
+      ?.map { listOf(it).toMap() }
+      ?.toMutableList()
+
+    val methodSecurity = this.security
+      ?.map { (k, v) -> k to v }
+      ?.map { listOf(it).toMap() }
+      ?.toMutableList()
+
+    return when {
+      configSecurity == null && methodSecurity == null -> null
+      configSecurity == null -> methodSecurity
+      methodSecurity == null -> configSecurity
+      else -> configSecurity.plus(methodSecurity).toMutableList()
+    }
+  }
+
   private fun List<ResponseInfo>.toResponseMap(): Map<Int, Response> = associate { error ->
     error.responseCode.value to Response(
       description = error.description,
+      headers = error.responseHeaders,
       content = error.responseType.toReferenceContent(
         examples = error.examples,
         mediaTypes = error.mediaTypes,
-        enrichment = error.typeEnrichment
+        enrichment = error.enrichment
       )
     )
   }

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

@@ -0,0 +1,172 @@
+package io.bkbn.kompendium.core
+
+import dev.forst.ktor.apikey.apiKey
+import io.bkbn.kompendium.core.fixtures.TestHelpers
+import io.bkbn.kompendium.core.util.customAuthConfig
+import io.bkbn.kompendium.core.util.customScopesOnSiblingPathOperations
+import io.bkbn.kompendium.core.util.defaultAuthConfig
+import io.bkbn.kompendium.core.util.multipleAuthStrategies
+import io.bkbn.kompendium.oas.component.Components
+import io.bkbn.kompendium.oas.security.ApiKeyAuth
+import io.bkbn.kompendium.oas.security.BasicAuth
+import io.bkbn.kompendium.oas.security.BearerAuth
+import io.bkbn.kompendium.oas.security.OAuth
+import io.kotest.core.spec.style.DescribeSpec
+import io.ktor.client.HttpClient
+import io.ktor.client.engine.cio.CIO
+import io.ktor.http.HttpMethod
+import io.ktor.server.application.install
+import io.ktor.server.auth.Authentication
+import io.ktor.server.auth.OAuthServerSettings
+import io.ktor.server.auth.Principal
+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
+
+class KompendiumAuthenticationTest : DescribeSpec({
+  describe("Authentication") {
+    it("Can add a default auth config by default") {
+      TestHelpers.openApiTestAllSerializers(
+        snapshotName = "T0045__default_auth_config.json",
+        applicationSetup = {
+          install(Authentication) {
+            basic("basic") {
+              realm = "Ktor Server"
+              validate { UserIdPrincipal("Placeholder") }
+            }
+          }
+        },
+        specOverrides = {
+          this.copy(
+            components = Components(
+              securitySchemes = mutableMapOf(
+                "basic" to BasicAuth()
+              )
+            )
+          )
+        }
+      ) { defaultAuthConfig() }
+    }
+    it("Can provide custom auth config with proper scopes") {
+      TestHelpers.openApiTestAllSerializers(
+        snapshotName = "T0046__custom_auth_config.json",
+        applicationSetup = {
+          install(Authentication) {
+            oauth("auth-oauth-google") {
+              urlProvider = { "http://localhost:8080/callback" }
+              providerLookup = {
+                OAuthServerSettings.OAuth2ServerSettings(
+                  name = "google",
+                  authorizeUrl = "https://accounts.google.com/o/oauth2/auth",
+                  accessTokenUrl = "https://accounts.google.com/o/oauth2/token",
+                  requestMethod = HttpMethod.Post,
+                  clientId = "DUMMY_VAL",
+                  clientSecret = "DUMMY_VAL",
+                  defaultScopes = listOf("https://www.googleapis.com/auth/userinfo.profile"),
+                  extraTokenParameters = listOf("access_type" to "offline")
+                )
+              }
+              client = HttpClient(CIO)
+            }
+          }
+        },
+        specOverrides = {
+          this.copy(
+            components = Components(
+              securitySchemes = mutableMapOf(
+                "auth-oauth-google" to OAuth(
+                  flows = OAuth.Flows(
+                    implicit = OAuth.Flows.Implicit(
+                      authorizationUrl = "https://accounts.google.com/o/oauth2/auth",
+                      scopes = mapOf(
+                        "write:pets" to "modify pets in your account",
+                        "read:pets" to "read your pets"
+                      )
+                    )
+                  )
+                )
+              )
+            )
+          )
+        }
+      ) { customAuthConfig() }
+    }
+    it("Can provide multiple authentication strategies") {
+      data class TestAppPrincipal(val key: String) : Principal
+      TestHelpers.openApiTestAllSerializers(
+        snapshotName = "T0047__multiple_auth_strategies.json",
+        applicationSetup = {
+          install(Authentication) {
+            apiKey("api-key") {
+              headerName = "X-API-KEY"
+              validate { key ->
+                // api key library (dev.forst.ktor.apikey) is using the deprecated `Principal` class
+                key
+                  .takeIf { it == "api-key" }
+                  ?.let { TestAppPrincipal(it) }
+              }
+            }
+            jwt("jwt") {
+              realm = "Server"
+            }
+          }
+        },
+        specOverrides = {
+          this.copy(
+            components = Components(
+              securitySchemes = mutableMapOf(
+                "jwt" to BearerAuth("JWT"),
+                "api-key" to ApiKeyAuth(ApiKeyAuth.ApiKeyLocation.HEADER, "X-API-KEY")
+              )
+            )
+          )
+        }
+      ) { multipleAuthStrategies() }
+    }
+    it("Can provide different scopes on path operations in the same route") {
+      TestHelpers.openApiTestAllSerializers(
+        snapshotName = "T0074__auth_on_specific_path_operation.json",
+        applicationSetup = {
+          install(Authentication) {
+            oauth("auth-oauth-google") {
+              urlProvider = { "http://localhost:8080/callback" }
+              providerLookup = {
+                OAuthServerSettings.OAuth2ServerSettings(
+                  name = "google",
+                  authorizeUrl = "https://accounts.google.com/o/oauth2/auth",
+                  accessTokenUrl = "https://accounts.google.com/o/oauth2/token",
+                  requestMethod = HttpMethod.Post,
+                  clientId = "DUMMY_VAL",
+                  clientSecret = "DUMMY_VAL",
+                  defaultScopes = listOf("https://www.googleapis.com/auth/userinfo.profile"),
+                  extraTokenParameters = listOf("access_type" to "offline")
+                )
+              }
+              client = HttpClient(CIO)
+            }
+          }
+        },
+        specOverrides = {
+          this.copy(
+            components = Components(
+              securitySchemes = mutableMapOf(
+                "auth-oauth-google" to OAuth(
+                  flows = OAuth.Flows(
+                    implicit = OAuth.Flows.Implicit(
+                      authorizationUrl = "https://accounts.google.com/o/oauth2/auth",
+                      scopes = mapOf(
+                        "write:pets" to "modify pets in your account",
+                        "read:pets" to "read your pets"
+                      )
+                    )
+                  )
+                )
+              )
+            )
+          )
+        }
+      ) { customScopesOnSiblingPathOperations() }
+    }
+  }
+})

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

@@ -0,0 +1,35 @@
+package io.bkbn.kompendium.core
+
+import io.bkbn.kompendium.core.fixtures.TestHelpers
+import io.bkbn.kompendium.core.util.arrayConstraints
+import io.bkbn.kompendium.core.util.doubleConstraints
+import io.bkbn.kompendium.core.util.intConstraints
+import io.bkbn.kompendium.core.util.stringConstraints
+import io.bkbn.kompendium.core.util.stringContentEncodingConstraints
+import io.bkbn.kompendium.core.util.stringPatternConstraints
+import io.kotest.core.spec.style.DescribeSpec
+
+class KompendiumConstraintsTest : DescribeSpec({
+  describe("Constraints") {
+    it("Can apply constraints to an int field") {
+      TestHelpers.openApiTestAllSerializers("T0059__int_constraints.json") { intConstraints() }
+    }
+    it("Can apply constraints to a double field") {
+      TestHelpers.openApiTestAllSerializers("T0060__double_constraints.json") { doubleConstraints() }
+    }
+    it("Can apply a min and max length to a string field") {
+      TestHelpers.openApiTestAllSerializers("T0061__string_min_max_constraints.json") { stringConstraints() }
+    }
+    it("Can apply a pattern to a string field") {
+      TestHelpers.openApiTestAllSerializers("T0062__string_pattern_constraints.json") { stringPatternConstraints() }
+    }
+    it("Can apply a content encoding and media type to a string field") {
+      TestHelpers.openApiTestAllSerializers("T0063__string_content_encoding_constraints.json") {
+        stringContentEncodingConstraints()
+      }
+    }
+    it("Can apply constraints to an array field") {
+      TestHelpers.openApiTestAllSerializers("T0064__array_constraints.json") { arrayConstraints() }
+    }
+  }
+})

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

@@ -0,0 +1,13 @@
+package io.bkbn.kompendium.core
+
+import io.bkbn.kompendium.core.fixtures.TestHelpers
+import io.bkbn.kompendium.core.util.defaultParameter
+import io.kotest.core.spec.style.DescribeSpec
+
+class KompendiumDefaultsTest : DescribeSpec({
+  describe("Defaults") {
+    it("Can generate a default parameter value") {
+      TestHelpers.openApiTestAllSerializers("T0022__query_with_default_parameter.json") { defaultParameter() }
+    }
+  }
+})

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

@@ -0,0 +1,39 @@
+package io.bkbn.kompendium.core
+
+import io.bkbn.kompendium.core.fixtures.TestHelpers.openApiTestAllSerializers
+import io.bkbn.kompendium.core.util.enrichedComplexGenericType
+import io.bkbn.kompendium.core.util.enrichedGenericResponse
+import io.bkbn.kompendium.core.util.enrichedMap
+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.enrichedTopLevelCollection
+import io.kotest.core.spec.style.DescribeSpec
+
+class KompendiumEnrichmentTest : DescribeSpec({
+  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() }
+    }
+    it("Can enrich a generic object") {
+      openApiTestAllSerializers("T0067__enriched_generic_object.json") { enrichedGenericResponse() }
+    }
+    it("Can enrich a top level list type") {
+      openApiTestAllSerializers("T0077__enriched_top_level_list.json") { enrichedTopLevelCollection() }
+    }
+    it("can enrich a map type") {
+      openApiTestAllSerializers("T0078__enriched_top_level_map.json") { enrichedMap() }
+    }
+  }
+})

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

@@ -0,0 +1,45 @@
+package io.bkbn.kompendium.core
+
+import io.bkbn.kompendium.core.fixtures.TestHelpers
+import io.bkbn.kompendium.core.util.dateTimeString
+import io.bkbn.kompendium.core.util.samePathSameMethod
+import io.bkbn.kompendium.json.schema.exception.UnknownSchemaException
+import io.kotest.assertions.throwables.shouldThrow
+import io.kotest.core.spec.style.DescribeSpec
+import io.kotest.matchers.should
+import io.kotest.matchers.string.startWith
+import io.ktor.server.application.install
+import io.ktor.server.auth.Authentication
+import io.ktor.server.auth.UserIdPrincipal
+import io.ktor.server.auth.basic
+
+class KompendiumErrorHandlingTest : DescribeSpec({
+  describe("Error Handling") {
+    it("Throws a clear exception when an unidentified type is encountered") {
+      val exception = shouldThrow<UnknownSchemaException> {
+        TestHelpers.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> {
+        TestHelpers.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")
+    }
+  }
+})

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

@@ -0,0 +1,27 @@
+package io.bkbn.kompendium.core
+
+import io.bkbn.kompendium.core.fixtures.TestHelpers
+import io.bkbn.kompendium.core.util.exampleParams
+import io.bkbn.kompendium.core.util.exampleSummaryAndDescription
+import io.bkbn.kompendium.core.util.optionalReqExample
+import io.bkbn.kompendium.core.util.reqRespExamples
+import io.kotest.core.spec.style.DescribeSpec
+
+class KompendiumExamplesTest : DescribeSpec({
+  describe("Examples") {
+    it("Can generate example response and request bodies") {
+      TestHelpers.openApiTestAllSerializers("T0020__example_req_and_resp.json") { reqRespExamples() }
+    }
+    it("Can describe example parameters") {
+      TestHelpers.openApiTestAllSerializers("T0021__example_parameters.json") { exampleParams() }
+    }
+    it("Can generate example optional request body") {
+      TestHelpers.openApiTestAllSerializers("T0069__example_optional_req.json") { optionalReqExample() }
+    }
+    it("Can generate example summary and description") {
+      TestHelpers.openApiTestAllSerializers(
+        "T0075__example_summary_and_description.json"
+      ) { exampleSummaryAndDescription() }
+    }
+  }
+})

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

@@ -0,0 +1,27 @@
+package io.bkbn.kompendium.core
+
+import io.bkbn.kompendium.core.fixtures.TestHelpers
+import io.bkbn.kompendium.core.util.genericException
+import io.bkbn.kompendium.core.util.multipleExceptions
+import io.bkbn.kompendium.core.util.polymorphicException
+import io.bkbn.kompendium.core.util.singleException
+import io.kotest.core.spec.style.DescribeSpec
+
+class KompendiumExceptionsTest : DescribeSpec({
+  describe("Exceptions") {
+    it("Can add an exception status code to a response") {
+      TestHelpers.openApiTestAllSerializers("T0016__notarized_get_with_exception_response.json") { singleException() }
+    }
+    it("Can support multiple response codes") {
+      TestHelpers.openApiTestAllSerializers("T0017__notarized_get_with_multiple_exception_responses.json") {
+        multipleExceptions()
+      }
+    }
+    it("Can add a polymorphic exception response") {
+      TestHelpers.openApiTestAllSerializers("T0018__polymorphic_error_status_codes.json") { polymorphicException() }
+    }
+    it("Can add a generic exception response") {
+      TestHelpers.openApiTestAllSerializers("T0019__generic_exception.json") { genericException() }
+    }
+  }
+})

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

@@ -0,0 +1,7 @@
+package io.bkbn.kompendium.core
+
+import io.kotest.core.spec.style.DescribeSpec
+
+class KompendiumFreeFormTest : DescribeSpec({
+  // todo Assess strategies here
+})

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

@@ -0,0 +1,67 @@
+package io.bkbn.kompendium.core
+
+import io.bkbn.kompendium.core.fixtures.TestHelpers
+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.nestedGenericCollection
+import io.bkbn.kompendium.core.util.nestedGenericMultipleParamsCollection
+import io.bkbn.kompendium.core.util.nestedGenericResponse
+import io.bkbn.kompendium.core.util.overrideSealedTypeIdentifier
+import io.bkbn.kompendium.core.util.polymorphicCollectionResponse
+import io.bkbn.kompendium.core.util.polymorphicMapResponse
+import io.bkbn.kompendium.core.util.polymorphicResponse
+import io.bkbn.kompendium.core.util.simpleGenericResponse
+import io.bkbn.kompendium.core.util.subtypeNotCompleteSetOfParentProperties
+import io.kotest.core.spec.style.DescribeSpec
+
+class KompendiumPolymorphismAndGenericsTest : DescribeSpec({
+  describe("Polymorphism and Generics") {
+    it("can generate a polymorphic response type") {
+      TestHelpers.openApiTestAllSerializers("T0027__polymorphic_response.json") { polymorphicResponse() }
+    }
+    it("Can generate a collection with polymorphic response type") {
+      TestHelpers.openApiTestAllSerializers("T0028__polymorphic_list_response.json") { polymorphicCollectionResponse() }
+    }
+    it("Can generate a map with a polymorphic response type") {
+      TestHelpers.openApiTestAllSerializers("T0029__polymorphic_map_response.json") { polymorphicMapResponse() }
+    }
+    it("Can generate a response type with a generic type") {
+      TestHelpers.openApiTestAllSerializers("T0030__simple_generic_response.json") { simpleGenericResponse() }
+    }
+    it("Can generate a response type with a nested generic type") {
+      TestHelpers.openApiTestAllSerializers("T0031__nested_generic_response.json") { nestedGenericResponse() }
+    }
+    it("Can generate a polymorphic response type with generics") {
+      TestHelpers.openApiTestAllSerializers(
+        "T0032__polymorphic_response_with_generics.json"
+      ) { genericPolymorphicResponse() }
+    }
+    it("Can handle an absolutely psycho inheritance test") {
+      TestHelpers.openApiTestAllSerializers("T0033__crazy_polymorphic_example.json") {
+        genericPolymorphicResponseMultipleImpls()
+      }
+    }
+    it("Can support nested generic collections") {
+      TestHelpers.openApiTestAllSerializers("T0039__nested_generic_collection.json") { nestedGenericCollection() }
+    }
+    it("Can support nested generics with multiple type parameters") {
+      TestHelpers.openApiTestAllSerializers("T0040__nested_generic_multiple_type_params.json") {
+        nestedGenericMultipleParamsCollection()
+      }
+    }
+    it("Can handle a really gnarly generic example") {
+      TestHelpers.openApiTestAllSerializers("T0043__gnarly_generic_example.json") { gnarlyGenericResponse() }
+    }
+    it("Can override the type name for a sealed interface implementation") {
+      TestHelpers.openApiTestAllSerializers("T0070__sealed_interface_type_name_override.json") {
+        overrideSealedTypeIdentifier()
+      }
+    }
+    it("Can serialize an object where the subtype is not a complete set of parent properties") {
+      TestHelpers.openApiTestAllSerializers("T0071__subtype_not_complete_set_of_parent_properties.json") {
+        subtypeNotCompleteSetOfParentProperties()
+      }
+    }
+  }
+})

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

@@ -0,0 +1,25 @@
+package io.bkbn.kompendium.core
+
+import io.bkbn.kompendium.core.fixtures.TestHelpers
+import io.bkbn.kompendium.core.util.defaultField
+import io.bkbn.kompendium.core.util.nonRequiredParam
+import io.bkbn.kompendium.core.util.nullableField
+import io.bkbn.kompendium.core.util.requiredParams
+import io.kotest.core.spec.style.DescribeSpec
+
+class KompendiumRequiredFieldsTest : DescribeSpec({
+  describe("Required Fields") {
+    it("Marks a parameter as required if there is no default and it is not marked nullable") {
+      TestHelpers.openApiTestAllSerializers("T0023__required_param.json") { requiredParams() }
+    }
+    it("Can mark a parameter as not required") {
+      TestHelpers.openApiTestAllSerializers("T0024__non_required_param.json") { nonRequiredParam() }
+    }
+    it("Does not mark a field as required if a default value is provided") {
+      TestHelpers.openApiTestAllSerializers("T0025__default_field.json") { defaultField() }
+    }
+    it("Does not mark a nullable field as required") {
+      TestHelpers.openApiTestAllSerializers("T0026__nullable_field.json") { nullableField() }
+    }
+  }
+})

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

@@ -0,0 +1,29 @@
+package io.bkbn.kompendium.core
+
+import io.bkbn.kompendium.core.fixtures.TestHelpers
+import io.bkbn.kompendium.core.util.nestedUnderRoot
+import io.bkbn.kompendium.core.util.paramWrapper
+import io.bkbn.kompendium.core.util.rootRoute
+import io.bkbn.kompendium.core.util.simplePathParsing
+import io.bkbn.kompendium.core.util.trailingSlash
+import io.kotest.core.spec.style.DescribeSpec
+
+class KompendiumRouteParsingTest : DescribeSpec({
+  describe("Route Parsing") {
+    it("Can parse a simple path and store it under the expected route") {
+      TestHelpers.openApiTestAllSerializers("T0012__path_parser.json") { simplePathParsing() }
+    }
+    it("Can notarize the root route") {
+      TestHelpers.openApiTestAllSerializers("T0013__root_route.json") { rootRoute() }
+    }
+    it("Can notarize a route under the root module without appending trailing slash") {
+      TestHelpers.openApiTestAllSerializers("T0014__nested_under_root.json") { nestedUnderRoot() }
+    }
+    it("Can notarize a route with a trailing slash") {
+      TestHelpers.openApiTestAllSerializers("T0015__trailing_slash.json") { trailingSlash() }
+    }
+    it("Can notarize a route with a parameter") {
+      TestHelpers.openApiTestAllSerializers("T0068__param_wrapper.json") { paramWrapper() }
+    }
+  }
+})

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

@@ -1,35 +1,13 @@
 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.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.fieldOutsideConstructor
-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
@@ -44,52 +22,32 @@ 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.postNoReqBody
-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.primitives
-import io.bkbn.kompendium.core.util.reqRespExamples
 import io.bkbn.kompendium.core.util.requiredParams
+import io.bkbn.kompendium.core.util.responseHeaders
+import io.bkbn.kompendium.core.util.returnsEnumList
 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
-import io.bkbn.kompendium.oas.security.ApiKeyAuth
 import io.bkbn.kompendium.oas.security.BasicAuth
-import io.bkbn.kompendium.oas.security.BearerAuth
+import io.bkbn.kompendium.oas.serialization.KompendiumSerializersModule
-import io.bkbn.kompendium.oas.security.OAuth
-import io.kotest.assertions.throwables.shouldThrow
 import io.kotest.core.spec.style.DescribeSpec
-import io.kotest.matchers.should
+import io.ktor.serialization.kotlinx.json.json
-import io.kotest.matchers.string.startWith
-import io.ktor.client.HttpClient
-import io.ktor.client.engine.cio.CIO
-import io.ktor.http.HttpMethod
 import io.ktor.server.application.install
 import io.ktor.server.auth.Authentication
-import io.ktor.server.auth.OAuthServerSettings
 import io.ktor.server.auth.UserIdPrincipal
 import io.ktor.server.auth.basic
-import io.ktor.server.auth.jwt.jwt
+import io.ktor.server.response.respondText
-import io.ktor.server.auth.oauth
+import io.ktor.server.routing.get
+import io.ktor.server.routing.route
+import kotlinx.serialization.encodeToString
+import kotlinx.serialization.json.Json
 import java.net.URI
-import java.time.Instant
-import kotlin.reflect.typeOf
 
 class KompendiumTest : DescribeSpec({
   describe("Notarized Open API Metadata Tests") {
@@ -129,46 +87,11 @@ class KompendiumTest : DescribeSpec({
     it("Can override media types") {
       openApiTestAllSerializers("T0052__override_media_types.json") { overrideMediaTypes() }
     }
-  }
+    it("Can support a post request with no request body") {
-  describe("Route Parsing") {
+      openApiTestAllSerializers("T0065__post_no_req_body.json") { postNoReqBody() }
-    it("Can parse a simple path and store it under the expected route") {
-      openApiTestAllSerializers("T0012__path_parser.json") { simplePathParsing() }
     }
-    it("Can notarize the root route") {
+    it("Can notarize a route with response headers") {
-      openApiTestAllSerializers("T0013__root_route.json") { rootRoute() }
+      openApiTestAllSerializers("T0066__notarized_get_with_response_headers.json") { responseHeaders() }
-    }
-    it("Can notarize a route under the root module without appending trailing slash") {
-      openApiTestAllSerializers("T0014__nested_under_root.json") { nestedUnderRoot() }
-    }
-    it("Can notarize a route with a trailing slash") {
-      openApiTestAllSerializers("T0015__trailing_slash.json") { trailingSlash() }
-    }
-  }
-  describe("Exceptions") {
-    it("Can add an exception status code to a response") {
-      openApiTestAllSerializers("T0016__notarized_get_with_exception_response.json") { singleException() }
-    }
-    it("Can support multiple response codes") {
-      openApiTestAllSerializers("T0017__notarized_get_with_multiple_exception_responses.json") { multipleExceptions() }
-    }
-    it("Can add a polymorphic exception response") {
-      openApiTestAllSerializers("T0018__polymorphic_error_status_codes.json") { polymorphicException() }
-    }
-    it("Can add a generic exception response") {
-      openApiTestAllSerializers("T0019__generic_exception.json") { genericException() }
-    }
-  }
-  describe("Examples") {
-    it("Can generate example response and request bodies") {
-      openApiTestAllSerializers("T0020__example_req_and_resp.json") { reqRespExamples() }
-    }
-    it("Can describe example parameters") {
-      openApiTestAllSerializers("T0021__example_parameters.json") { exampleParams() }
-    }
-  }
-  describe("Defaults") {
-    it("Can generate a default parameter value") {
-      openApiTestAllSerializers("T0022__query_with_default_parameter.json") { defaultParameter() }
     }
   }
   describe("Required Fields") {
@@ -185,40 +108,6 @@ class KompendiumTest : DescribeSpec({
       openApiTestAllSerializers("T0026__nullable_field.json") { nullableField() }
     }
   }
-  describe("Polymorphism and Generics") {
-    it("can generate a polymorphic response type") {
-      openApiTestAllSerializers("T0027__polymorphic_response.json") { polymorphicResponse() }
-    }
-    it("Can generate a collection with polymorphic response type") {
-      openApiTestAllSerializers("T0028__polymorphic_list_response.json") { polymorphicCollectionResponse() }
-    }
-    it("Can generate a map with a polymorphic response type") {
-      openApiTestAllSerializers("T0029__polymorphic_map_response.json") { polymorphicMapResponse() }
-    }
-    it("Can generate a response type with a generic type") {
-      openApiTestAllSerializers("T0030__simple_generic_response.json") { simpleGenericResponse() }
-    }
-    it("Can generate a response type with a nested generic type") {
-      openApiTestAllSerializers("T0031__nested_generic_response.json") { nestedGenericResponse() }
-    }
-    it("Can generate a polymorphic response type with generics") {
-      openApiTestAllSerializers("T0032__polymorphic_response_with_generics.json") { genericPolymorphicResponse() }
-    }
-    it("Can handle an absolutely psycho inheritance test") {
-      openApiTestAllSerializers("T0033__crazy_polymorphic_example.json") { genericPolymorphicResponseMultipleImpls() }
-    }
-    it("Can support nested generic collections") {
-      openApiTestAllSerializers("T0039__nested_generic_collection.json") { nestedGenericCollection() }
-    }
-    it("Can support nested generics with multiple type parameters") {
-      openApiTestAllSerializers("T0040__nested_generic_multiple_type_params.json") {
-        nestedGenericMultipleParamsCollection()
-      }
-    }
-    it("Can handle a really gnarly generic example") {
-      openApiTestAllSerializers("T0043__gnarly_generic_example.json") { gnarlyGenericResponse() }
-    }
-  }
   describe("Custom Serializable Reader tests") {
     it("Can support ignoring fields") {
       openApiTestAllSerializers("T0048__ignored_property.json") { ignoredFieldsResponse() }
@@ -255,6 +144,9 @@ class KompendiumTest : DescribeSpec({
     it("Can have a nullable enum as a member field") {
       openApiTestAllSerializers("T0037__nullable_enum_field.json") { nullableEnumField() }
     }
+    it("Can have a list of enums as a field") {
+      openApiTestAllSerializers("T0076__list_of_enums.json") { returnsEnumList() }
+    }
     it("Can have a nullable reference without impacting base type") {
       openApiTestAllSerializers("T0041__nullable_reference.json") { nullableReference() }
     }
@@ -289,182 +181,49 @@ class KompendiumTest : DescribeSpec({
     it("Can generate paths without application root-path") {
       openApiTestAllSerializers(
         "T0054__app_with_rootpath.json",
-        applicationEnvironmentBuilder = {
+        applicationSetup = {
           rootPath = "/example"
         },
         specOverrides = {
           copy(
             servers = servers.map { it.copy(url = URI("${it.url}/example")) }.toMutableList()
           )
+        },
+        serverConfigSetup = {
+          rootPath = "/example"
         }
       ) { notarizedGet() }
     }
-  }
+    it("Can apply a custom serialization strategy to the openapi document") {
-  describe("Error Handling") {
+      val customJsonEncoder = Json {
-    it("Throws a clear exception when an unidentified type is encountered") {
+        serializersModule = KompendiumSerializersModule.module
-      val exception = shouldThrow<UnknownSchemaException> { openApiTestAllSerializers("") { dateTimeString() } }
+        encodeDefaults = true
-      exception.message should startWith("An unknown type was encountered: class java.time.Instant")
+        explicitNulls = false
-    }
-    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("Formats") {
-    it("Can set a format for a simple type schema") {
       openApiTestAllSerializers(
-        snapshotName = "T0038__formatted_date_time_string.json",
+        snapshotName = "T0072__custom_serialization_strategy.json",
-        customTypes = mapOf(typeOf<Instant>() to TypeDefinition(type = "string", format = "date"))
+        notarizedApplicationConfigOverrides = {
-      ) { dateTimeString() }
+          specRoute = { spec, routing ->
-    }
+            routing.route("/openapi.json") {
-  }
+              get {
-  describe("Free Form") {
+                call.response.headers.append("Content-Type", "application/json")
-    // todo Assess strategies here
+                call.respondText { customJsonEncoder.encodeToString(spec) }
-  }
-  describe("Authentication") {
-    it("Can add a default auth config by default") {
-      openApiTestAllSerializers(
-        snapshotName = "T0045__default_auth_config.json",
-        applicationSetup = {
-          install(Authentication) {
-            basic("basic") {
-              realm = "Ktor Server"
-              validate { UserIdPrincipal("Placeholder") }
-            }
-          }
-        },
-        specOverrides = {
-          this.copy(
-            components = Components(
-              securitySchemes = mutableMapOf(
-                "basic" to BasicAuth()
-              )
-            )
-          )
-        }
-      ) { defaultAuthConfig() }
-    }
-    it("Can provide custom auth config with proper scopes") {
-      openApiTestAllSerializers(
-        snapshotName = "T0046__custom_auth_config.json",
-        applicationSetup = {
-          install(Authentication) {
-            oauth("auth-oauth-google") {
-              urlProvider = { "http://localhost:8080/callback" }
-              providerLookup = {
-                OAuthServerSettings.OAuth2ServerSettings(
-                  name = "google",
-                  authorizeUrl = "https://accounts.google.com/o/oauth2/auth",
-                  accessTokenUrl = "https://accounts.google.com/o/oauth2/token",
-                  requestMethod = HttpMethod.Post,
-                  clientId = "DUMMY_VAL",
-                  clientSecret = "DUMMY_VAL",
-                  defaultScopes = listOf("https://www.googleapis.com/auth/userinfo.profile"),
-                  extraTokenParameters = listOf("access_type" to "offline")
-                )
-              }
-              client = HttpClient(CIO)
-            }
-          }
-        },
-        specOverrides = {
-          this.copy(
-            components = Components(
-              securitySchemes = mutableMapOf(
-                "auth-oauth-google" to OAuth(
-                  flows = OAuth.Flows(
-                    implicit = OAuth.Flows.Implicit(
-                      authorizationUrl = "https://accounts.google.com/o/oauth2/auth",
-                      scopes = mapOf(
-                        "write:pets" to "modify pets in your account",
-                        "read:pets" to "read your pets"
-                      )
-                    )
-                  )
-                )
-              )
-            )
-          )
-        }
-      ) { customAuthConfig() }
-    }
-    it("Can provide multiple authentication strategies") {
-      openApiTestAllSerializers(
-        snapshotName = "T0047__multiple_auth_strategies.json",
-        applicationSetup = {
-          install(Authentication) {
-            apiKey("api-key") {
-              headerName = "X-API-KEY"
-              validate {
-                UserIdPrincipal("Placeholder")
               }
             }
-            jwt("jwt") {
-              realm = "Server"
-            }
           }
         },
-        specOverrides = {
+        contentNegotiation = {
-          this.copy(
+          json(
-            components = Components(
+            Json {
-              securitySchemes = mutableMapOf(
+              encodeDefaults = true
-                "jwt" to BearerAuth("JWT"),
+              explicitNulls = true
-                "api-key" to ApiKeyAuth(ApiKeyAuth.ApiKeyLocation.HEADER, "X-API-KEY")
+            }
-              )
-            )
           )
         }
-      ) { multipleAuthStrategies() }
+      ) { notarizedGet() }
     }
-  }
+    it("Can serialize a data class with a field outside of the constructor") {
-  describe("Enrichment") {
+      openApiTestAllSerializers("T0073__data_class_with_field_outside_constructor.json") { fieldOutsideConstructor() }
-    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/KompendiumTypeFormatTest.kt

@@ -0,0 +1,19 @@
+package io.bkbn.kompendium.core
+
+import io.bkbn.kompendium.core.fixtures.TestHelpers
+import io.bkbn.kompendium.core.util.dateTimeString
+import io.bkbn.kompendium.json.schema.definition.TypeDefinition
+import io.kotest.core.spec.style.DescribeSpec
+import java.time.Instant
+import kotlin.reflect.typeOf
+
+class KompendiumTypeFormatTest : DescribeSpec({
+  describe("Formats") {
+    it("Can set a format for a simple type schema") {
+      TestHelpers.openApiTestAllSerializers(
+        snapshotName = "T0038__formatted_date_time_string.json",
+        customTypes = mapOf(typeOf<Instant>() to TypeDefinition(type = "string", format = "date"))
+      ) { dateTimeString() }
+    }
+  }
+})

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

@@ -2,18 +2,18 @@ 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.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.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
 import io.ktor.server.routing.route
 
-fun Routing.defaultAuthConfig() {
+fun Route.defaultAuthConfig() {
   authenticate("basic") {
     route(rootPath) {
       basicGetGenerator<TestResponse>()
@@ -21,7 +21,7 @@ fun Routing.defaultAuthConfig() {
   }
 }
 
-fun Routing.customAuthConfig() {
+fun Route.customAuthConfig() {
   authenticate("auth-oauth-google") {
     route(rootPath) {
       install(NotarizedRoute()) {
@@ -42,7 +42,44 @@ fun Routing.customAuthConfig() {
   }
 }
 
-fun Routing.multipleAuthStrategies() {
+fun Route.customScopesOnSiblingPathOperations() {
+  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")
+          )
+        }
+        post = PostInfo.builder {
+          summary(defaultPathSummary)
+          description(defaultPathDescription)
+          response {
+            description(defaultResponseDescription)
+            responseCode(HttpStatusCode.OK)
+            responseType<TestResponse>()
+          }
+          request {
+            description(defaultResponseDescription)
+            requestType<TestResponse>()
+          }
+          security = mapOf(
+            "auth-oauth-google" to listOf("write:pets")
+          )
+        }
+      }
+    }
+  }
+}
+
+fun Route.multipleAuthStrategies() {
   authenticate("jwt", "api-key") {
     route(rootPath) {
       basicGetGenerator<TestResponse>()

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

@@ -7,13 +7,15 @@ 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.bkbn.kompendium.enrichment.CollectionEnrichment
+import io.bkbn.kompendium.enrichment.NumberEnrichment
+import io.bkbn.kompendium.enrichment.ObjectEnrichment
+import io.bkbn.kompendium.enrichment.StringEnrichment
 import io.ktor.http.HttpStatusCode
-import io.ktor.server.application.install
+import io.ktor.server.routing.Route
-import io.ktor.server.routing.Routing
 import io.ktor.server.routing.route
 
-fun Routing.intConstraints() {
+fun Route.intConstraints() {
   route(defaultPath) {
     install(NotarizedRoute()) {
       get = GetInfo.builder {
@@ -23,22 +25,24 @@ fun Routing.intConstraints() {
           responseCode(HttpStatusCode.OK)
           description("An int")
           responseType(
-            enrichment = TypeEnrichment("example") {
+            enrichment = ObjectEnrichment("example") {
               TestCreatedResponse::id {
-                minimum = 2
+                NumberEnrichment("blah-blah-blah") {
-                maximum = 100
+                  minimum = 2
-                multipleOf = 2
+                  maximum = 100
+                  multipleOf = 2
+                }
               }
+              responseCode(HttpStatusCode.OK)
             }
           )
-          responseCode(HttpStatusCode.OK)
         }
       }
     }
   }
 }
 
-fun Routing.doubleConstraints() {
+fun Route.doubleConstraints() {
   route(defaultPath) {
     install(NotarizedRoute()) {
       get = GetInfo.builder {
@@ -48,11 +52,13 @@ fun Routing.doubleConstraints() {
           responseCode(HttpStatusCode.OK)
           description("A double")
           responseType(
-            enrichment = TypeEnrichment("example") {
+            enrichment = ObjectEnrichment("example") {
               DoubleResponse::payload {
-                minimum = 2.0
+                NumberEnrichment("blah-blah-blah") {
-                maximum = 100.0
+                  minimum = 2.0
-                multipleOf = 2.0
+                  maximum = 100.0
+                  multipleOf = 2.0
+                }
               }
             }
           )
@@ -63,7 +69,7 @@ fun Routing.doubleConstraints() {
   }
 }
 
-fun Routing.stringConstraints() {
+fun Route.stringConstraints() {
   route(defaultPath) {
     install(NotarizedRoute()) {
       get = GetInfo.builder {
@@ -73,10 +79,12 @@ fun Routing.stringConstraints() {
           responseCode(HttpStatusCode.OK)
           description("A string")
           responseType(
-            enrichment = TypeEnrichment("example") {
+            enrichment = ObjectEnrichment("example") {
               TestNested::nesty {
-                maxLength = 10
+                StringEnrichment("blah") {
-                minLength = 2
+                  maxLength = 10
+                  minLength = 2
+                }
               }
             }
           )
@@ -87,7 +95,7 @@ fun Routing.stringConstraints() {
   }
 }
 
-fun Routing.stringPatternConstraints() {
+fun Route.stringPatternConstraints() {
   route(defaultPath) {
     install(NotarizedRoute()) {
       get = GetInfo.builder {
@@ -97,9 +105,11 @@ fun Routing.stringPatternConstraints() {
           responseCode(HttpStatusCode.OK)
           description("A string")
           responseType(
-            enrichment = TypeEnrichment("example") {
+            enrichment = ObjectEnrichment("example") {
               TestNested::nesty {
-                pattern = "[a-z]+"
+                StringEnrichment("blah") {
+                  pattern = "[a-z]+"
+                }
               }
             }
           )
@@ -110,7 +120,7 @@ fun Routing.stringPatternConstraints() {
   }
 }
 
-fun Routing.stringContentEncodingConstraints() {
+fun Route.stringContentEncodingConstraints() {
   route(defaultPath) {
     install(NotarizedRoute()) {
       get = GetInfo.builder {
@@ -120,10 +130,12 @@ fun Routing.stringContentEncodingConstraints() {
           responseCode(HttpStatusCode.OK)
           description("A string")
           responseType(
-            enrichment = TypeEnrichment("example") {
+            enrichment = ObjectEnrichment("example") {
               TestNested::nesty {
-                contentEncoding = "base64"
+                StringEnrichment("blah") {
-                contentMediaType = "image/png"
+                  contentEncoding = "base64"
+                  contentMediaType = "image/png"
+                }
               }
             }
           )
@@ -134,7 +146,7 @@ fun Routing.stringContentEncodingConstraints() {
   }
 }
 
-fun Routing.arrayConstraints() {
+fun Route.arrayConstraints() {
   route(defaultPath) {
     install(NotarizedRoute()) {
       get = GetInfo.builder {
@@ -144,11 +156,13 @@ fun Routing.arrayConstraints() {
           responseCode(HttpStatusCode.OK)
           description("An array")
           responseType(
-            enrichment = TypeEnrichment("example") {
+            enrichment = ObjectEnrichment("example") {
               Page<String>::content {
-                minItems = 2
+                CollectionEnrichment<String>("blah") {
-                maxItems = 10
+                  minItems = 2
-                uniqueItems = true
+                  maxItems = 10
+                  uniqueItems = true
+                }
               }
             }
           )

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

@@ -3,8 +3,8 @@ 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
+import io.ktor.server.routing.Route
 
-fun Routing.ignoredFieldsResponse() = basicGetGenerator<TransientObject>()
+fun Route.ignoredFieldsResponse() = basicGetGenerator<TransientObject>()
-fun Routing.unbackedFieldsResponse() = basicGetGenerator<UnbackedObject>()
+fun Route.unbackedFieldsResponse() = basicGetGenerator<UnbackedObject>()
-fun Routing.customFieldNameResponse() = basicGetGenerator<SerialNameObject>()
+fun Route.customFieldNameResponse() = basicGetGenerator<SerialNameObject>()

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

@@ -3,9 +3,9 @@ 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
+import io.ktor.server.routing.Route
 
-fun Routing.defaultParameter() = basicGetGenerator<TestResponse>(
+fun Route.defaultParameter() = basicGetGenerator<TestResponse>(
   params = listOf(
     Parameter(
       name = "id",

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

@@ -1,6 +1,7 @@
 package io.bkbn.kompendium.core.util
 
 import io.bkbn.kompendium.core.fixtures.ComplexRequest
+import io.bkbn.kompendium.core.fixtures.GenericObject
 import io.bkbn.kompendium.core.fixtures.MultiNestedGenerics
 import io.bkbn.kompendium.core.fixtures.NestedComplexItem
 import io.bkbn.kompendium.core.fixtures.TestCreatedResponse
@@ -9,13 +10,17 @@ 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.bkbn.kompendium.enrichment.BooleanEnrichment
+import io.bkbn.kompendium.enrichment.CollectionEnrichment
+import io.bkbn.kompendium.enrichment.MapEnrichment
+import io.bkbn.kompendium.enrichment.NumberEnrichment
+import io.bkbn.kompendium.enrichment.ObjectEnrichment
+import io.bkbn.kompendium.enrichment.StringEnrichment
 import io.ktor.http.HttpStatusCode
-import io.ktor.server.application.install
+import io.ktor.server.routing.Route
-import io.ktor.server.routing.Routing
 import io.ktor.server.routing.route
 
-fun Routing.enrichedSimpleResponse() {
+fun Route.enrichedSimpleResponse() {
   route("/enriched") {
     install(NotarizedRoute()) {
       get = GetInfo.builder {
@@ -23,9 +28,11 @@ fun Routing.enrichedSimpleResponse() {
         description(TestModules.defaultPathDescription)
         response {
           responseType(
-            enrichment = TypeEnrichment("simple") {
+            enrichment = ObjectEnrichment("simple") {
               TestResponse::c {
-                description = "A simple description"
+                StringEnrichment("blah-blah-blah") {
+                  description = "A simple description"
+                }
               }
             }
           )
@@ -37,7 +44,7 @@ fun Routing.enrichedSimpleResponse() {
   }
 }
 
-fun Routing.enrichedSimpleRequest() {
+fun Route.enrichedSimpleRequest() {
   route("/example") {
     install(NotarizedRoute()) {
       parameters = TestModules.defaultParams
@@ -46,45 +53,20 @@ fun Routing.enrichedSimpleRequest() {
         description(TestModules.defaultPathDescription)
         request {
           requestType(
-            enrichment = TypeEnrichment("simple") {
+            enrichment = ObjectEnrichment("simple") {
               TestSimpleRequest::a {
-                description = "A simple description"
+                StringEnrichment("blah-blah-blah") {
-              }
+                  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"
-                  }
                 }
               }
+              TestSimpleRequest::b {
+                NumberEnrichment("blah-blah-blah") {
+                  deprecated = true
+                }
+              }
+              TestSimpleRequest::c {
+                BooleanEnrichment("blah-blah-blah") { }
+              }
             }
           )
           description("A test request")
@@ -99,7 +81,7 @@ fun Routing.enrichedNestedCollection() {
   }
 }
 
-fun Routing.enrichedComplexGenericType() {
+fun Route.enrichedNestedCollection() {
   route("/example") {
     install(NotarizedRoute()) {
       parameters = TestModules.defaultParams
@@ -108,14 +90,13 @@ fun Routing.enrichedComplexGenericType() {
         description(TestModules.defaultPathDescription)
         request {
           requestType(
-            enrichment = TypeEnrichment("simple") {
+            enrichment = ObjectEnrichment("simple") {
-              MultiNestedGenerics<String, ComplexRequest>::content {
+              ComplexRequest::tables {
-                description = "Getting pretty crazy"
+                CollectionEnrichment<NestedComplexItem>("blah-blah") {
-                typeEnrichment = TypeEnrichment("nested") {
+                  description = "A nested description"
-                  ComplexRequest::tables {
+                  itemEnrichment = ObjectEnrichment("nested") {
-                    description = "A nested item"
+                    NestedComplexItem::name {
-                    typeEnrichment = TypeEnrichment("nested") {
+                      StringEnrichment("beleheh") {
-                      NestedComplexItem::name {
                         description = "A nested description"
                       }
                     }
@@ -135,3 +116,149 @@ fun Routing.enrichedComplexGenericType() {
     }
   }
 }
+
+fun Route.enrichedTopLevelCollection() {
+  route("/example") {
+    install(NotarizedRoute()) {
+      parameters = TestModules.defaultParams
+      post = PostInfo.builder {
+        summary(TestModules.defaultPathSummary)
+        description(TestModules.defaultPathDescription)
+        request {
+          requestType(
+            enrichment = CollectionEnrichment<List<TestSimpleRequest>>("blah-blah") {
+              itemEnrichment = ObjectEnrichment("simple") {
+                TestSimpleRequest::a {
+                  StringEnrichment("blah-blah-blah") {
+                    description = "A simple description"
+                  }
+                }
+                TestSimpleRequest::b {
+                  NumberEnrichment("blah-blah-blah") {
+                    deprecated = true
+                  }
+                }
+              }
+            }
+          )
+          description("A test request")
+        }
+        response {
+          responseCode(HttpStatusCode.Created)
+          responseType<TestCreatedResponse>()
+          description(TestModules.defaultResponseDescription)
+        }
+      }
+    }
+  }
+}
+
+fun Route.enrichedComplexGenericType() {
+  route("/example") {
+    install(NotarizedRoute()) {
+      parameters = TestModules.defaultParams
+      post = PostInfo.builder {
+        summary(TestModules.defaultPathSummary)
+        description(TestModules.defaultPathDescription)
+        request {
+          requestType(
+            enrichment = ObjectEnrichment("simple") {
+              MultiNestedGenerics<String, ComplexRequest>::content {
+                MapEnrichment<ComplexRequest>("blah") {
+                  description = "A nested description"
+                  valueEnrichment = ObjectEnrichment("nested") {
+                    ComplexRequest::tables {
+                      CollectionEnrichment<NestedComplexItem>("blah-blah") {
+                        description = "A nested description"
+                        itemEnrichment = ObjectEnrichment("nested") {
+                          NestedComplexItem::name {
+                            StringEnrichment("beleheh") {
+                              description = "A nested description"
+                            }
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          )
+          description("A test request")
+        }
+        response {
+          responseCode(HttpStatusCode.Created)
+          responseType<TestCreatedResponse>()
+          description(TestModules.defaultResponseDescription)
+        }
+      }
+    }
+  }
+}
+
+fun Route.enrichedGenericResponse() {
+  route("/example") {
+    install(NotarizedRoute()) {
+      get = GetInfo.builder {
+        summary(TestModules.defaultPathSummary)
+        description(TestModules.defaultPathDescription)
+        response {
+          responseType(
+            enrichment = ObjectEnrichment("generic") {
+              description = "another description"
+              GenericObject<TestSimpleRequest>::data {
+                ObjectEnrichment("simple") {
+                  description = "also a description"
+                  TestSimpleRequest::a {
+                    StringEnrichment("blah-blah-blah") {
+                      description = "A simple description"
+                    }
+                  }
+                  TestSimpleRequest::b {
+                    NumberEnrichment("blah-blah-blah") {
+                      deprecated = true
+                    }
+                  }
+                }
+              }
+            }
+          )
+          description("A good response")
+          responseCode(HttpStatusCode.Created)
+        }
+      }
+    }
+  }
+}
+
+fun Route.enrichedMap() {
+  route("/example") {
+    install(NotarizedRoute()) {
+      get = GetInfo.builder {
+        summary(TestModules.defaultPathSummary)
+        description(TestModules.defaultPathDescription)
+        response {
+          responseType<Map<String, TestSimpleRequest>>(
+            enrichment = MapEnrichment("blah") {
+              description = "A nested description"
+              valueEnrichment = ObjectEnrichment("nested") {
+                TestSimpleRequest::a {
+                  StringEnrichment("blah-blah-blah") {
+                    description = "A simple description"
+                  }
+                }
+                TestSimpleRequest::b {
+                  NumberEnrichment("blah-blah-blah") {
+                    deprecated = true
+                  }
+                }
+              }
+            }
+          )
+          description("A good response")
+          responseCode(HttpStatusCode.Created)
+        }
+      }
+    }
+  }
+}

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

@@ -3,10 +3,10 @@ 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
 import io.ktor.server.routing.route
 
-fun Routing.samePathSameMethod() {
+fun Route.samePathSameMethod() {
   route(defaultPath) {
     basicGetGenerator<TestResponse>()
     authenticate("basic") {

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

@@ -11,13 +11,13 @@ 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.MediaType
 import io.bkbn.kompendium.oas.payload.Parameter
 import io.ktor.http.HttpStatusCode
-import io.ktor.server.application.install
+import io.ktor.server.routing.Route
-import io.ktor.server.routing.Routing
 import io.ktor.server.routing.route
 
-fun Routing.reqRespExamples() {
+fun Route.reqRespExamples() {
   route(rootPath) {
     install(NotarizedRoute()) {
       post = PostInfo.builder {
@@ -27,7 +27,7 @@ fun Routing.reqRespExamples() {
           description(defaultRequestDescription)
           requestType<TestRequest>()
           examples(
-            "Testerina" to TestRequest(TestNested("asdf"), 1.5, emptyList())
+            "Testerina" to MediaType.Example(TestRequest(TestNested("asdf"), 1.5, emptyList()))
           )
         }
         response {
@@ -35,7 +35,7 @@ fun Routing.reqRespExamples() {
           responseCode(HttpStatusCode.OK)
           responseType<TestResponse>()
           examples(
-            "Testerino" to TestResponse("Heya")
+            "Testerino" to MediaType.Example(TestResponse("Heya"))
           )
         }
       }
@@ -43,15 +43,72 @@ fun Routing.reqRespExamples() {
   }
 }
 
-fun Routing.exampleParams() = basicGetGenerator<TestResponse>(
+fun Route.exampleParams() = basicGetGenerator<TestResponse>(
   params = listOf(
     Parameter(
       name = "id",
       `in` = Parameter.Location.path,
       schema = TypeDefinition.STRING,
       examples = mapOf(
-        "foo" to Parameter.Example("testing")
+        "foo" to MediaType.Example("testing")
       )
     )
   )
 )
+
+fun Route.optionalReqExample() {
+  route(rootPath) {
+    install(NotarizedRoute()) {
+      post = PostInfo.builder {
+        summary(defaultPathSummary)
+        description(defaultPathDescription)
+        request {
+          description(defaultRequestDescription)
+          requestType<TestRequest>()
+          examples(
+            "Testerina" to MediaType.Example(TestRequest(TestNested("asdf"), 1.5, emptyList()))
+          )
+          required(false)
+        }
+        response {
+          description(defaultResponseDescription)
+          responseCode(HttpStatusCode.OK)
+          responseType<TestResponse>()
+          examples(
+            "Testerino" to MediaType.Example(TestResponse("Heya"))
+          )
+        }
+      }
+    }
+  }
+}
+
+fun Route.exampleSummaryAndDescription() {
+  route(rootPath) {
+    install(NotarizedRoute()) {
+      post = PostInfo.builder {
+        summary("This is a summary")
+        description("This is a description")
+        request {
+          description("This is a request description")
+          requestType<TestRequest>()
+          examples(
+            "Testerina" to MediaType.Example(
+              TestRequest(TestNested("asdf"), 1.5, emptyList()),
+              "summary",
+              "description"
+            )
+          )
+        }
+        response {
+          description("This is a response description")
+          responseCode(HttpStatusCode.OK)
+          responseType<TestResponse>()
+          examples(
+            "Testerino" to MediaType.Example(TestResponse("Heya"), "summary", "description")
+          )
+        }
+      }
+    }
+  }
+}

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

@@ -11,11 +11,10 @@ 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.Route
-import io.ktor.server.routing.Routing
 import io.ktor.server.routing.route
 
-fun Routing.singleException() {
+fun Route.singleException() {
   route(rootPath) {
     install(NotarizedRoute()) {
       get = GetInfo.builder {
@@ -36,7 +35,7 @@ fun Routing.singleException() {
   }
 }
 
-fun Routing.multipleExceptions() {
+fun Route.multipleExceptions() {
   route(rootPath) {
     install(NotarizedRoute()) {
       get = GetInfo.builder {
@@ -62,7 +61,7 @@ fun Routing.multipleExceptions() {
   }
 }
 
-fun Routing.polymorphicException() {
+fun Route.polymorphicException() {
   route(rootPath) {
     install(NotarizedRoute()) {
       get = GetInfo.builder {
@@ -83,7 +82,7 @@ fun Routing.polymorphicException() {
   }
 }
 
-fun Routing.genericException() {
+fun Route.genericException() {
   route(rootPath) {
     install(NotarizedRoute()) {
       get = GetInfo.builder {

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

@@ -21,17 +21,16 @@ 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
 import io.ktor.server.routing.route
 
-fun Routing.withOperationId() = basicGetGenerator<TestResponse>(operationId = "getThisDude")
+fun Route.withOperationId() = basicGetGenerator<TestResponse>(operationId = "getThisDude")
-fun Routing.nullableNestedObject() = basicGetGenerator<ProfileUpdateRequest>()
+fun Route.nullableNestedObject() = basicGetGenerator<ProfileUpdateRequest>()
-fun Routing.nullableEnumField() = basicGetGenerator<NullableEnum>()
+fun Route.nullableEnumField() = basicGetGenerator<NullableEnum>()
-fun Routing.nullableReference() = basicGetGenerator<ManyThings>()
+fun Route.nullableReference() = basicGetGenerator<ManyThings>()
-fun Routing.dateTimeString() = basicGetGenerator<DateTimeString>()
+fun Route.dateTimeString() = basicGetGenerator<DateTimeString>()
-fun Routing.headerParameter() = basicGetGenerator<TestResponse>(
+fun Route.headerParameter() = basicGetGenerator<TestResponse>(
   params = listOf(
     Parameter(
       name = "X-User-Email",
@@ -42,10 +41,10 @@ fun Routing.headerParameter() = basicGetGenerator<TestResponse>(
   )
 )
 
-fun Routing.nestedTypeName() = basicGetGenerator<Nested.Response>()
+fun Route.nestedTypeName() = basicGetGenerator<Nested.Response>()
-fun Routing.topLevelNullable() = basicGetGenerator<TestResponse?>()
+fun Route.topLevelNullable() = basicGetGenerator<TestResponse?>()
-fun Routing.simpleRecursive() = basicGetGenerator<ColumnSchema>()
+fun Route.simpleRecursive() = basicGetGenerator<ColumnSchema>()
-fun Routing.samePathDifferentMethodsAndAuth() {
+fun Route.samePathDifferentMethodsAndAuth() {
   route(defaultPath) {
     install(NotarizedRoute()) {
       parameters = defaultParams

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

@@ -1,7 +1,9 @@
 package io.bkbn.kompendium.core.util
 
 import io.bkbn.kompendium.core.fixtures.ComplexRequest
+import io.bkbn.kompendium.core.fixtures.SomethingSimilar
 import io.bkbn.kompendium.core.fixtures.TestCreatedResponse
+import io.bkbn.kompendium.core.fixtures.TestEnum
 import io.bkbn.kompendium.core.fixtures.TestRequest
 import io.bkbn.kompendium.core.fixtures.TestResponse
 import io.bkbn.kompendium.core.fixtures.TestSimpleRequest
@@ -20,13 +22,13 @@ import io.bkbn.kompendium.core.util.TestModules.defaultPathSummary
 import io.bkbn.kompendium.core.util.TestModules.defaultResponseDescription
 import io.bkbn.kompendium.core.util.TestModules.rootPath
 import io.bkbn.kompendium.json.schema.definition.TypeDefinition
+import io.bkbn.kompendium.oas.payload.Header
 import io.bkbn.kompendium.oas.payload.Parameter
+import io.ktor.http.HttpHeaders
 import io.ktor.http.HttpStatusCode
-import io.ktor.server.application.call
-import io.ktor.server.application.install
 import io.ktor.server.response.respond
 import io.ktor.server.response.respondText
-import io.ktor.server.routing.Routing
+import io.ktor.server.routing.Route
 import io.ktor.server.routing.delete
 import io.ktor.server.routing.get
 import io.ktor.server.routing.head
@@ -36,7 +38,7 @@ import io.ktor.server.routing.post
 import io.ktor.server.routing.put
 import io.ktor.server.routing.route
 
-fun Routing.notarizedGet() {
+fun Route.notarizedGet() {
   route(defaultPath) {
     install(NotarizedRoute()) {
       parameters = defaultParams
@@ -56,7 +58,39 @@ fun Routing.notarizedGet() {
   }
 }
 
-fun Routing.notarizedPost() {
+fun Route.responseHeaders() {
+  route(defaultPath) {
+    install(NotarizedRoute()) {
+      parameters = defaultParams
+      get = GetInfo.builder {
+        response {
+          responseCode(HttpStatusCode.OK)
+          responseType<TestResponse>()
+          description(defaultResponseDescription)
+          responseHeaders(
+            mapOf(
+              HttpHeaders.ETag to Header(
+                TypeDefinition.STRING,
+                "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag"
+              ),
+              HttpHeaders.LastModified to Header(
+                TypeDefinition.STRING,
+                "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Last-Modified"
+              ),
+            )
+          )
+        }
+        summary(defaultPathSummary)
+        description(defaultPathDescription)
+      }
+    }
+    get {
+      call.respondText { "hey dude ‼️ congrats on the get request" }
+    }
+  }
+}
+
+fun Route.notarizedPost() {
   route(defaultPath) {
     install(NotarizedRoute()) {
       parameters = defaultParams
@@ -80,7 +114,7 @@ fun Routing.notarizedPost() {
   }
 }
 
-fun Routing.notarizedPut() {
+fun Route.notarizedPut() {
   route(defaultPath) {
     install(NotarizedRoute()) {
       parameters = defaultParams
@@ -104,7 +138,7 @@ fun Routing.notarizedPut() {
   }
 }
 
-fun Routing.notarizedDelete() {
+fun Route.notarizedDelete() {
   route(defaultPath) {
     install(NotarizedRoute()) {
       parameters = defaultParams
@@ -124,7 +158,7 @@ fun Routing.notarizedDelete() {
   }
 }
 
-fun Routing.notarizedPatch() {
+fun Route.notarizedPatch() {
   route(defaultPath) {
     install(NotarizedRoute()) {
       parameters = defaultParams
@@ -148,7 +182,7 @@ fun Routing.notarizedPatch() {
   }
 }
 
-fun Routing.notarizedHead() {
+fun Route.notarizedHead() {
   route(defaultPath) {
     install(NotarizedRoute()) {
       parameters = defaultParams
@@ -169,7 +203,7 @@ fun Routing.notarizedHead() {
   }
 }
 
-fun Routing.notarizedOptions() {
+fun Route.notarizedOptions() {
   route(defaultPath) {
     install(NotarizedRoute()) {
       parameters = defaultParams
@@ -189,7 +223,7 @@ fun Routing.notarizedOptions() {
   }
 }
 
-fun Routing.complexRequest() {
+fun Route.complexRequest() {
   route(rootPath) {
     install(NotarizedRoute()) {
       put = PutInfo.builder {
@@ -212,7 +246,7 @@ fun Routing.complexRequest() {
   }
 }
 
-fun Routing.primitives() {
+fun Route.primitives() {
   route(rootPath) {
     install(NotarizedRoute()) {
       put = PutInfo.builder {
@@ -232,7 +266,7 @@ fun Routing.primitives() {
   }
 }
 
-fun Routing.returnsList() {
+fun Route.returnsList() {
   route(defaultPath) {
     install(NotarizedRoute()) {
       parameters = defaultParams
@@ -249,7 +283,24 @@ fun Routing.returnsList() {
   }
 }
 
-fun Routing.nonRequiredParams() {
+fun Route.returnsEnumList() {
+  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<TestEnum>>()
+        }
+      }
+    }
+  }
+}
+
+fun Route.nonRequiredParams() {
   route("/optional") {
     install(NotarizedRoute()) {
       parameters = listOf(
@@ -278,7 +329,7 @@ fun Routing.nonRequiredParams() {
   }
 }
 
-fun Routing.overrideMediaTypes() {
+fun Route.overrideMediaTypes() {
   route("/media_types") {
     install(NotarizedRoute()) {
       put = PutInfo.builder {
@@ -299,3 +350,39 @@ fun Routing.overrideMediaTypes() {
     }
   }
 }
+
+fun Route.postNoReqBody() {
+  route("/no_req_body") {
+    install(NotarizedRoute()) {
+      post = PostInfo.builder {
+        summary(defaultPathSummary)
+        description(defaultPathDescription)
+        response {
+          responseType<TestResponse>()
+          description("Cool response")
+          responseCode(HttpStatusCode.Created)
+        }
+      }
+    }
+  }
+}
+
+fun Route.fieldOutsideConstructor() {
+  route("/field_outside_constructor") {
+    install(NotarizedRoute()) {
+      post = PostInfo.builder {
+        summary(defaultPathSummary)
+        description(defaultPathDescription)
+        request {
+          requestType<SomethingSimilar>()
+          description("A cool request")
+        }
+        response {
+          responseType<TestResponse>()
+          description("Cool response")
+          responseCode(HttpStatusCode.Created)
+        }
+      }
+    }
+  }
+}

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

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

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

@@ -5,9 +5,9 @@ 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
+import io.ktor.server.routing.Route
 
-fun Routing.requiredParams() = basicGetGenerator<TestResponse>(
+fun Route.requiredParams() = basicGetGenerator<TestResponse>(
   params = listOf(
     Parameter(
       name = "id",
@@ -17,7 +17,7 @@ fun Routing.requiredParams() = basicGetGenerator<TestResponse>(
   )
 )
 
-fun Routing.nonRequiredParam() = basicGetGenerator<TestResponse>(
+fun Route.nonRequiredParam() = basicGetGenerator<TestResponse>(
   params = listOf(
     Parameter(
       name = "id",
@@ -28,5 +28,5 @@ fun Routing.nonRequiredParam() = basicGetGenerator<TestResponse>(
   )
 )
 
-fun Routing.defaultField() = basicGetGenerator<DefaultField>()
+fun Route.defaultField() = basicGetGenerator<DefaultField>()
-fun Routing.nullableField() = basicGetGenerator<NullableField>()
+fun Route.nullableField() = basicGetGenerator<NullableField>()

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

@@ -11,11 +11,11 @@ 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.Route
-import io.ktor.server.routing.Routing
 import io.ktor.server.routing.route
+import io.ktor.server.routing.param
 
-fun Routing.simplePathParsing() {
+fun Route.simplePathParsing() {
   route("/this") {
     route("/is") {
       route("/a") {
@@ -48,7 +48,7 @@ fun Routing.simplePathParsing() {
   }
 }
 
-fun Routing.rootRoute() {
+fun Route.rootRoute() {
   route(rootPath) {
     install(NotarizedRoute()) {
       parameters = listOf(defaultParams.last())
@@ -65,7 +65,7 @@ fun Routing.rootRoute() {
   }
 }
 
-fun Routing.nestedUnderRoot() {
+fun Route.nestedUnderRoot() {
   route("/") {
     route("/testerino") {
       install(NotarizedRoute()) {
@@ -83,7 +83,7 @@ fun Routing.nestedUnderRoot() {
   }
 }
 
-fun Routing.trailingSlash() {
+fun Route.trailingSlash() {
   route("/test") {
     route("/") {
       install(NotarizedRoute()) {
@@ -100,3 +100,32 @@ fun Routing.trailingSlash() {
     }
   }
 }
+
+fun Route.paramWrapper() {
+  route("/test") {
+    param("a") {
+      param("b") {
+        param("c") {
+          install(NotarizedRoute()) {
+            parameters = listOf(
+              Parameter(
+                name = "test",
+                `in` = Parameter.Location.query,
+                schema = TypeDefinition.STRING
+              )
+            )
+            get = GetInfo.builder {
+              summary(defaultPathSummary)
+              description(defaultPathDescription)
+              response {
+                description(defaultResponseDescription)
+                responseCode(HttpStatusCode.OK)
+                responseType<TestResponse>()
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

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

@@ -9,7 +9,6 @@ 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.Route
 import io.ktor.server.routing.Routing
 import io.ktor.server.routing.route

core/src/test/resources/T0002__notarized_post.json

@@ -109,11 +109,15 @@
           "b": {
             "type": "number",
             "format": "int32"
+          },
+          "c": {
+            "type": "boolean"
           }
         },
         "required": [
           "a",
-          "b"
+          "b",
+          "c"
         ]
       }
     },

core/src/test/resources/T0003__notarized_put.json

@@ -109,11 +109,15 @@
           "b": {
             "type": "number",
             "format": "int32"
+          },
+          "c": {
+            "type": "boolean"
           }
         },
         "required": [
           "a",
-          "b"
+          "b",
+          "c"
         ]
       }
     },

core/src/test/resources/T0005__notarized_patch.json

@@ -109,11 +109,15 @@
           "b": {
             "type": "number",
             "format": "int32"
+          },
+          "c": {
+            "type": "boolean"
           }
         },
         "required": [
           "a",
-          "b"
+          "b",
+          "c"
         ]
       }
     },

core/src/test/resources/T0008__complex_type.json

@@ -132,7 +132,6 @@
         ]
       },
       "SimpleEnum": {
-        "type": "string",
         "enum": [
           "ONE",
           "TWO"

core/src/test/resources/T0018__polymorphic_error_status_codes.json

@@ -86,12 +86,18 @@
           },
           "z": {
             "type": "string"
+          },
+          "type": {
+            "enum": [
+              "io.bkbn.kompendium.core.fixtures.ComplexGibbit"
+            ]
           }
         },
         "required": [
           "b",
           "c",
-          "z"
+          "z",
+          "type"
         ]
       },
       "SimpleGibbit": {
@@ -102,10 +108,16 @@
           },
           "z": {
             "type": "string"
+          },
+          "type": {
+            "enum": [
+              "io.bkbn.kompendium.core.fixtures.SimpleGibbit"
+            ]
           }
         },
         "required": [
-          "a"
+          "a",
+          "type"
         ]
       },
       "FlibbityGibbit": {

core/src/test/resources/T0019__generic_exception.json

@@ -82,11 +82,17 @@
           },
           "f": {
             "type": "string"
+          },
+          "type": {
+            "enum": [
+              "io.bkbn.kompendium.core.fixtures.Bibbity"
+            ]
           }
         },
         "required": [
           "b",
-          "f"
+          "f",
+          "type"
         ]
       },
       "Gibbity-String": {
@@ -94,10 +100,16 @@
         "properties": {
           "a": {
             "type": "string"
+          },
+          "type": {
+            "enum": [
+              "io.bkbn.kompendium.core.fixtures.Gibbity"
+            ]
           }
         },
         "required": [
-          "a"
+          "a",
+          "type"
         ]
       },
       "Flibbity-String": {

core/src/test/resources/T0027__polymorphic_response.json

@@ -65,12 +65,18 @@
           },
           "z": {
             "type": "string"
+          },
+          "type": {
+            "enum": [
+              "io.bkbn.kompendium.core.fixtures.ComplexGibbit"
+            ]
           }
         },
         "required": [
           "b",
           "c",
-          "z"
+          "z",
+          "type"
         ]
       },
       "SimpleGibbit": {
@@ -81,10 +87,16 @@
           },
           "z": {
             "type": "string"
+          },
+          "type": {
+            "enum": [
+              "io.bkbn.kompendium.core.fixtures.SimpleGibbit"
+            ]
           }
         },
         "required": [
-          "a"
+          "a",
+          "type"
         ]
       },
       "FlibbityGibbit": {

core/src/test/resources/T0028__polymorphic_list_response.json

@@ -65,12 +65,18 @@
           },
           "z": {
             "type": "string"
+          },
+          "type": {
+            "enum": [
+              "io.bkbn.kompendium.core.fixtures.ComplexGibbit"
+            ]
           }
         },
         "required": [
           "b",
           "c",
-          "z"
+          "z",
+          "type"
         ]
       },
       "SimpleGibbit": {
@@ -81,10 +87,16 @@
           },
           "z": {
             "type": "string"
+          },
+          "type": {
+            "enum": [
+              "io.bkbn.kompendium.core.fixtures.SimpleGibbit"
+            ]
           }
         },
         "required": [
-          "a"
+          "a",
+          "type"
         ]
       },
       "List-FlibbityGibbit": {

core/src/test/resources/T0029__polymorphic_map_response.json

@@ -65,12 +65,18 @@
           },
           "z": {
             "type": "string"
+          },
+          "type": {
+            "enum": [
+              "io.bkbn.kompendium.core.fixtures.ComplexGibbit"
+            ]
           }
         },
         "required": [
           "b",
           "c",
-          "z"
+          "z",
+          "type"
         ]
       },
       "SimpleGibbit": {
@@ -81,10 +87,16 @@
           },
           "z": {
             "type": "string"
+          },
+          "type": {
+            "enum": [
+              "io.bkbn.kompendium.core.fixtures.SimpleGibbit"
+            ]
           }
         },
         "required": [
-          "a"
+          "a",
+          "type"
         ]
       },
       "Map-String-FlibbityGibbit": {

core/src/test/resources/T0032__polymorphic_response_with_generics.json

@@ -62,11 +62,17 @@
           "f": {
             "type": "number",
             "format": "double"
+          },
+          "type": {
+            "enum": [
+              "io.bkbn.kompendium.core.fixtures.Bibbity"
+            ]
           }
         },
         "required": [
           "b",
-          "f"
+          "f",
+          "type"
         ]
       },
       "Gibbity-Double": {
@@ -75,10 +81,16 @@
           "a": {
             "type": "number",
             "format": "double"
+          },
+          "type": {
+            "enum": [
+              "io.bkbn.kompendium.core.fixtures.Gibbity"
+            ]
           }
         },
         "required": [
-          "a"
+          "a",
+          "type"
         ]
       },
       "Flibbity-Double": {

core/src/test/resources/T0033__crazy_polymorphic_example.json

@@ -53,40 +53,6 @@
   "webhooks": {},
   "components": {
     "schemas": {
-      "ComplexGibbit": {
-        "type": "object",
-        "properties": {
-          "b": {
-            "type": "string"
-          },
-          "c": {
-            "type": "number",
-            "format": "int32"
-          },
-          "z": {
-            "type": "string"
-          }
-        },
-        "required": [
-          "b",
-          "c",
-          "z"
-        ]
-      },
-      "SimpleGibbit": {
-        "type": "object",
-        "properties": {
-          "a": {
-            "type": "string"
-          },
-          "z": {
-            "type": "string"
-          }
-        },
-        "required": [
-          "a"
-        ]
-      },
       "Bibbity-FlibbityGibbit": {
         "type": "object",
         "properties": {
@@ -102,11 +68,63 @@
                 "$ref": "#/components/schemas/SimpleGibbit"
               }
             ]
+          },
+          "type": {
+            "enum": [
+              "io.bkbn.kompendium.core.fixtures.Bibbity"
+            ]
           }
         },
         "required": [
           "b",
-          "f"
+          "f",
+          "type"
+        ]
+      },
+      "ComplexGibbit": {
+        "type": "object",
+        "properties": {
+          "b": {
+            "type": "string"
+          },
+          "c": {
+            "type": "number",
+            "format": "int32"
+          },
+          "z": {
+            "type": "string"
+          },
+          "type": {
+            "enum": [
+              "io.bkbn.kompendium.core.fixtures.ComplexGibbit"
+            ]
+          }
+        },
+        "required": [
+          "b",
+          "c",
+          "z",
+          "type"
+        ]
+      },
+      "SimpleGibbit": {
+        "type": "object",
+        "properties": {
+          "a": {
+            "type": "string"
+          },
+          "z": {
+            "type": "string"
+          },
+          "type": {
+            "enum": [
+              "io.bkbn.kompendium.core.fixtures.SimpleGibbit"
+            ]
+          }
+        },
+        "required": [
+          "a",
+          "type"
         ]
       },
       "Gibbity-FlibbityGibbit": {
@@ -121,10 +139,16 @@
                 "$ref": "#/components/schemas/SimpleGibbit"
               }
             ]
+          },
+          "type": {
+            "enum": [
+              "io.bkbn.kompendium.core.fixtures.Gibbity"
+            ]
           }
         },
         "required": [
-          "a"
+          "a",
+          "type"
         ]
       },
       "Flibbity-FlibbityGibbit": {

core/src/test/resources/T0037__nullable_enum_field.json

@@ -71,7 +71,6 @@
       },
       "TestEnum":
           {
-            "type": "string",
             "enum": [
               "YES",
               "NO"

core/src/test/resources/T0040__nested_generic_multiple_type_params.json

@@ -119,7 +119,6 @@
         ]
       },
       "SimpleEnum": {
-        "type": "string",
         "enum": [
           "ONE",
           "TWO"

core/src/test/resources/T0042__simple_recursive.json

@@ -54,7 +54,6 @@
   "components": {
     "schemas": {
       "ColumnMode": {
-        "type": "string",
         "enum": [
           "NULLABLE",
           "REQUIRED",

core/src/test/resources/T0053__same_path_different_methods_and_auth.json

@@ -144,11 +144,15 @@
           "b": {
             "type": "number",
             "format": "int32"
+          },
+          "c": {
+            "type": "boolean"
           }
         },
         "required": [
           "a",
-          "b"
+          "b",
+          "c"
         ]
       }
     },

core/src/test/resources/T0055__enriched_simple_request.json

@@ -111,11 +111,15 @@
             "type": "number",
             "format": "int32",
             "deprecated": true
+          },
+          "c": {
+            "type": "boolean"
           }
         },
         "required": [
           "a",
-          "b"
+          "b",
+          "c"
         ]
       }
     },

core/src/test/resources/T0056__enriched_nested_collection.json

@@ -111,9 +111,9 @@
           },
           "tables": {
             "items": {
-              "$ref": "#/components/schemas/NestedComplexItem-nested"
+              "$ref": "#/components/schemas/NestedComplexItem-blah-blah"
             },
-            "description": "A nested item",
+            "description": "A nested description",
             "type": "array"
           }
         },
@@ -154,11 +154,29 @@
         ]
       },
       "SimpleEnum": {
-        "type": "string",
         "enum": [
           "ONE",
           "TWO"
         ]
+      },
+      "NestedComplexItem-blah-blah": {
+        "type": "object",
+        "properties": {
+          "alias": {
+            "additionalProperties": {
+              "$ref": "#/components/schemas/CrazyItem"
+            },
+            "type": "object"
+          },
+          "name": {
+            "type": "string",
+            "description": "A nested description"
+          }
+        },
+        "required": [
+          "alias",
+          "name"
+        ]
       }
     },
     "securitySchemes": {}

core/src/test/resources/T0057__enriched_complex_generic_type.json

@@ -105,9 +105,9 @@
         "properties": {
           "content": {
             "additionalProperties": {
-              "$ref": "#/components/schemas/ComplexRequest-nested"
+              "$ref": "#/components/schemas/ComplexRequest-blah"
             },
-            "description": "Getting pretty crazy",
+            "description": "A nested description",
             "type": "object"
           }
         },
@@ -126,9 +126,9 @@
           },
           "tables": {
             "items": {
-              "$ref": "#/components/schemas/NestedComplexItem-nested"
+              "$ref": "#/components/schemas/NestedComplexItem-blah-blah"
             },
-            "description": "A nested item",
+            "description": "A nested description",
             "type": "array"
           }
         },
@@ -169,11 +169,52 @@
         ]
       },
       "SimpleEnum": {
-        "type": "string",
         "enum": [
           "ONE",
           "TWO"
         ]
+      },
+      "NestedComplexItem-blah-blah": {
+        "type": "object",
+        "properties": {
+          "alias": {
+            "additionalProperties": {
+              "$ref": "#/components/schemas/CrazyItem"
+            },
+            "type": "object"
+          },
+          "name": {
+            "type": "string",
+            "description": "A nested description"
+          }
+        },
+        "required": [
+          "alias",
+          "name"
+        ]
+      },
+      "ComplexRequest-blah": {
+        "type": "object",
+        "properties": {
+          "amazingField": {
+            "type": "string"
+          },
+          "org": {
+            "type": "string"
+          },
+          "tables": {
+            "items": {
+              "$ref": "#/components/schemas/NestedComplexItem-blah-blah"
+            },
+            "description": "A nested description",
+            "type": "array"
+          }
+        },
+        "required": [
+          "amazingField",
+          "org",
+          "tables"
+        ]
       }
     },
     "securitySchemes": {}

core/src/test/resources/T0065__post_no_req_body.json

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

core/src/test/resources/T0066__notarized_get_with_response_headers.json

@@ -27,15 +27,33 @@
     }
   ],
   "paths": {
-    "/type/{name}/edit": {
+    "/test/{a}": {
       "get": {
         "tags": [],
-        "summary": "Edit",
+        "summary": "Great Summary!",
-        "description": "example location",
+        "description": "testing more",
         "parameters": [],
         "responses": {
           "200": {
-            "description": "does great things",
+            "description": "A Successful Endeavor",
+            "headers": {
+              "ETag": {
+                "schema": {
+                  "type": "string"
+                },
+                "description": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag",
+                "required": true,
+                "deprecated": false
+              },
+              "Last-Modified": {
+                "schema": {
+                  "type": "string"
+                },
+                "description": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Last-Modified",
+                "required": true,
+                "deprecated": false
+              }
+            },
             "content": {
               "application/json": {
                 "schema": {
@@ -49,39 +67,7 @@
       },
       "parameters": [
         {
-          "name": "name",
+          "name": "a",
-          "in": "path",
-          "schema": {
-            "type": "string"
-          },
-          "required": true,
-          "deprecated": false
-        }
-      ]
-    },
-    "/type/{name}/other/{page}": {
-      "get": {
-        "tags": [],
-        "summary": "Other",
-        "description": "example location",
-        "parameters": [],
-        "responses": {
-          "200": {
-            "description": "does great things",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/TestResponse"
-                }
-              }
-            }
-          }
-        },
-        "deprecated": false
-      },
-      "parameters": [
-        {
-          "name": "name",
           "in": "path",
           "schema": {
             "type": "string"
@@ -90,8 +76,8 @@
           "deprecated": false
         },
         {
-          "name": "page",
+          "name": "aa",
-          "in": "path",
+          "in": "query",
           "schema": {
             "type": "number",
             "format": "int32"

core/src/test/resources/T0067__enriched_generic_object.json

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

core/src/test/resources/T0068__param_wrapper.json

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

core/src/test/resources/T0069__example_optional_req.json

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

core/src/test/resources/T0070__sealed_interface_type_name_override.json

@@ -0,0 +1,106 @@
+{
+  "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": {
+    "/": {
+      "get": {
+        "tags": [],
+        "summary": "Great Summary!",
+        "description": "testing more",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": "A Successful Endeavor",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ChillaxificationMaximization"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "parameters": []
+    }
+  },
+  "webhooks": {},
+  "components": {
+    "schemas": {
+      "Chillax": {
+        "type": "object",
+        "properties": {
+          "a": {
+            "type": "string"
+          },
+          "type": {
+            "enum": [
+              "chillax"
+            ]
+          }
+        },
+        "required": [
+          "a",
+          "type"
+        ]
+      },
+      "ToDaMax": {
+        "type": "object",
+        "properties": {
+          "b": {
+            "type": "number",
+            "format": "int32"
+          },
+          "type": {
+            "enum": [
+              "maximize"
+            ]
+          }
+        },
+        "required": [
+          "b",
+          "type"
+        ]
+      },
+      "ChillaxificationMaximization": {
+        "anyOf": [
+          {
+            "$ref": "#/components/schemas/Chillax"
+          },
+          {
+            "$ref": "#/components/schemas/ToDaMax"
+          }
+        ]
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0071__subtype_not_complete_set_of_parent_properties.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": {
+    "/": {
+      "get": {
+        "tags": [],
+        "summary": "Great Summary!",
+        "description": "testing more",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": "A Successful Endeavor",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Gizmo"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "parameters": []
+    }
+  },
+  "webhooks": {},
+  "components": {
+    "schemas": {
+      "Gizmo": {
+        "type": "object",
+        "properties": {
+          "title": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "title"
+        ]
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0072__custom_serialization_strategy.json

@@ -27,15 +27,15 @@
     }
   ],
   "paths": {
-    "/list/{name}/page/{page}": {
+    "/test/{a}": {
       "get": {
         "tags": [],
-        "summary": "Location",
+        "summary": "Great Summary!",
-        "description": "example location",
+        "description": "testing more",
         "parameters": [],
         "responses": {
           "200": {
-            "description": "does great things",
+            "description": "A Successful Endeavor",
             "content": {
               "application/json": {
                 "schema": {
@@ -49,7 +49,7 @@
       },
       "parameters": [
         {
-          "name": "name",
+          "name": "a",
           "in": "path",
           "schema": {
             "type": "string"
@@ -58,8 +58,8 @@
           "deprecated": false
         },
         {
-          "name": "page",
+          "name": "aa",
-          "in": "path",
+          "in": "query",
           "schema": {
             "type": "number",
             "format": "int32"

core/src/test/resources/T0073__data_class_with_field_outside_constructor.json

@@ -0,0 +1,94 @@
+{
+  "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": {
+    "/field_outside_constructor": {
+      "post": {
+        "tags": [],
+        "summary": "Great Summary!",
+        "description": "testing more",
+        "parameters": [],
+        "requestBody": {
+          "description": "A cool request",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/SomethingSimilar"
+              }
+            }
+          },
+          "required": true
+        },
+        "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"
+        ]
+      },
+      "SomethingSimilar": {
+        "type": "object",
+        "properties": {
+          "a": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "a"
+        ]
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0074__auth_on_specific_path_operation.json

@@ -0,0 +1,129 @@
+{
+  "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": {
+    "/": {
+      "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,
+        "security": [
+          {
+            "auth-oauth-google": [
+              "read:pets"
+            ]
+          }
+        ]
+      },
+      "post": {
+        "tags": [],
+        "summary": "Great Summary!",
+        "description": "testing more",
+        "parameters": [],
+        "requestBody": {
+          "description": "A Successful Endeavor",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/TestResponse"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "A Successful Endeavor",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TestResponse"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false,
+        "security": [
+          {
+            "auth-oauth-google": [
+              "write:pets"
+            ]
+          }
+        ]
+      },
+      "parameters": []
+    }
+  },
+  "webhooks": {},
+  "components": {
+    "schemas": {
+      "TestResponse": {
+        "type": "object",
+        "properties": {
+          "c": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "c"
+        ]
+      }
+    },
+    "securitySchemes": {
+      "auth-oauth-google": {
+        "flows": {
+          "implicit": {
+            "authorizationUrl": "https://accounts.google.com/o/oauth2/auth",
+            "scopes": {
+              "write:pets": "modify pets in your account",
+              "read:pets": "read your pets"
+            }
+          }
+        },
+        "type": "oauth2"
+      }
+    }
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0075__example_summary_and_description.json

@@ -0,0 +1,140 @@
+{
+  "openapi": "3.1.0",
+  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
+  "info": {
+    "title": "Test API",
+    "version": "1.33.7",
+    "description": "An amazing, fully-ish 😉 generated API spec",
+    "termsOfService": "https://example.com",
+    "contact": {
+      "name": "Homer Simpson",
+      "url": "https://gph.is/1NPUDiM",
+      "email": "chunkylover53@aol.com"
+    },
+    "license": {
+      "name": "MIT",
+      "url": "https://github.com/bkbnio/kompendium/blob/main/LICENSE"
+    }
+  },
+  "servers": [
+    {
+      "url": "https://myawesomeapi.com",
+      "description": "Production instance of my API"
+    },
+    {
+      "url": "https://staging.myawesomeapi.com",
+      "description": "Where the fun stuff happens"
+    }
+  ],
+  "paths": {
+    "/": {
+      "post": {
+        "tags": [],
+        "summary": "This is a summary",
+        "description": "This is a description",
+        "parameters": [],
+        "requestBody": {
+          "description": "This is a request description",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/TestRequest"
+              },
+              "examples": {
+                "Testerina": {
+                  "value": {
+                    "fieldName": {
+                      "nesty": "asdf"
+                    },
+                    "b": 1.5,
+                    "aaa": []
+                  },
+                  "summary": "summary",
+                  "description": "description"
+                }
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "This is a response description",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TestResponse"
+                },
+                "examples": {
+                  "Testerino": {
+                    "value": {
+                      "c": "Heya"
+                    },
+                    "summary": "summary",
+                    "description": "description"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "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/T0076__list_of_enums.json

@@ -0,0 +1,93 @@
+{
+  "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 List-y Endeavor",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/List-TestEnum"
+                }
+              }
+            }
+          }
+        },
+        "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": {
+      "TestEnum": {
+        "enum": [
+          "YES",
+          "NO"
+        ]
+      },
+      "List-TestEnum": {
+        "items": {
+          "$ref": "#/components/schemas/TestEnum"
+        },
+        "type": "array"
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0077__enriched_top_level_list.json

@@ -0,0 +1,158 @@
+{
+  "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/List-TestSimpleRequest-blah-blah"
+              }
+            }
+          },
+          "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
+          },
+          "c": {
+            "type": "boolean"
+          }
+        },
+        "required": [
+          "a",
+          "b",
+          "c"
+        ]
+      },
+      "TestSimpleRequest-blah-blah": {
+        "type": "object",
+        "properties": {
+          "a": {
+            "type": "string",
+            "description": "A simple description"
+          },
+          "b": {
+            "type": "number",
+            "format": "int32",
+            "deprecated": true
+          },
+          "c": {
+            "type": "boolean"
+          }
+        },
+        "required": [
+          "a",
+          "b",
+          "c"
+        ]
+      },
+      "List-TestSimpleRequest-blah-blah": {
+        "items": {
+          "$ref": "#/components/schemas/TestSimpleRequest-blah-blah"
+        },
+        "type": "array"
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0078__enriched_top_level_map.json

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

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

@@ -1,54 +0,0 @@
-package io.bkbn.kompendium.core.fixtures
-
-import com.fasterxml.jackson.annotation.JsonIgnore
-import com.fasterxml.jackson.annotation.JsonProperty
-import com.google.gson.annotations.Expose
-import com.google.gson.annotations.SerializedName
-import io.bkbn.kompendium.json.schema.SchemaConfigurator
-import kotlin.reflect.KClass
-import kotlin.reflect.KProperty1
-import kotlin.reflect.full.memberProperties
-import kotlin.reflect.jvm.javaField
-
-/*
-  These are test implementation and may well be a good starting point for creating production ones.
-  Both Gson and Jackson are complex and can achieve this things is more than one way therefore
-  these will not always work hence why they are in the test package
- */
-
-class GsonSchemaConfigurator: SchemaConfigurator {
-
-  override fun serializableMemberProperties(clazz: KClass<*>): Collection<KProperty1<out Any, *>> {
-    // NOTE: This is test logic Expose is set at a global Gson level so configure to match your Gson set up
-    val hasAnyExpose = clazz.memberProperties.any { it.hasJavaAnnotation<Expose>() }
-    return if(hasAnyExpose) {
-      clazz.memberProperties
-        .filter { it.hasJavaAnnotation<Expose>() }
-    } else clazz.memberProperties
-  }
-
-  override fun serializableName(property: KProperty1<out Any, *>): String =
-    property.getJavaAnnotation<SerializedName>()?.value?: property.name
-
-}
-
-class JacksonSchemaConfigurator: SchemaConfigurator {
-
-  override fun serializableMemberProperties(clazz: KClass<*>): Collection<KProperty1<out Any, *>> =
-    clazz.memberProperties
-      .filterNot {
-        it.hasJavaAnnotation<JsonIgnore>()
-      }
-
-  override fun serializableName(property: KProperty1<out Any, *>): String =
-    property.getJavaAnnotation<JsonProperty>()?.value?: property.name
-
-}
-
-inline fun <reified T: Annotation> KProperty1<*, *>.hasJavaAnnotation(): Boolean {
-  return javaField?.isAnnotationPresent(T::class.java)?: false
-}
-
-inline fun <reified T: Annotation> KProperty1<*, *>.getJavaAnnotation(): T? {
-  return javaField?.getDeclaredAnnotation(T::class.java)
-}

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

@@ -1,7 +0,0 @@
-package io.bkbn.kompendium.core.fixtures
-
-enum class SupportedSerializer {
-  KOTLINX,
-  GSON,
-  JACKSON
-}

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

@@ -1,7 +1,5 @@
 package io.bkbn.kompendium.core.fixtures
 
-import com.fasterxml.jackson.annotation.JsonInclude
-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
@@ -16,19 +14,18 @@ import io.kotest.matchers.shouldNot
 import io.kotest.matchers.string.beBlank
 import io.ktor.client.request.get
 import io.ktor.client.statement.bodyAsText
-import io.ktor.http.ContentType
 import io.ktor.http.HttpStatusCode
-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.application.ServerConfigBuilder
+import io.ktor.server.engine.ApplicationEnvironmentBuilder
 import io.ktor.server.plugins.contentnegotiation.ContentNegotiation
-import io.ktor.server.routing.Routing
+import io.ktor.server.plugins.contentnegotiation.ContentNegotiationConfig
+import io.ktor.server.routing.Route
 import io.ktor.server.testing.ApplicationTestBuilder
 import io.ktor.server.testing.testApplication
-import java.io.File
 import kotlinx.serialization.json.Json
+import java.io.File
 import kotlin.reflect.KType
 
 object TestHelpers {
@@ -55,7 +52,7 @@ object TestHelpers {
   /**
    * This will take a provided JSON snapshot file, retrieve it from the resource folder,
    * and build a test ktor server to compare the expected output with the output found in the default
-   * OpenAPI json endpoint.  By default, this will run the same test with Gson, Kotlinx, and Jackson serializers
+   * OpenAPI json endpoint.
    * @param snapshotName The snapshot file to retrieve from the resources folder
    */
   fun openApiTestAllSerializers(
@@ -63,79 +60,62 @@ object TestHelpers {
     customTypes: Map<KType, JsonSchema> = emptyMap(),
     applicationSetup: Application.() -> Unit = { },
     specOverrides: OpenApiSpec.() -> OpenApiSpec = { this },
-    applicationEnvironmentBuilder: ApplicationEngineEnvironmentBuilder.() -> Unit = {},
+    applicationEnvironmentBuilder: ApplicationEnvironmentBuilder.() -> Unit = {},
-    routeUnderTest: Routing.() -> Unit
+    notarizedApplicationConfigOverrides: NotarizedApplication.Config.() -> Unit = {},
+    contentNegotiation: ContentNegotiationConfig.() -> Unit = {
+      json(Json {
+        encodeDefaults = true
+        explicitNulls = false
+        serializersModule = KompendiumSerializersModule.module
+      })
+    },
+
+    serverConfigSetup: ServerConfigBuilder.() -> Unit = { },
+    routeUnderTest: Route.() -> Unit
   ) {
     openApiTest(
       snapshotName,
-      SupportedSerializer.KOTLINX,
       routeUnderTest,
       applicationSetup,
       specOverrides,
       customTypes,
-      applicationEnvironmentBuilder
+      notarizedApplicationConfigOverrides,
-    )
+      contentNegotiation,
-    openApiTest(
+      applicationEnvironmentBuilder,
-      snapshotName,
+      serverConfigSetup
-      SupportedSerializer.JACKSON,
-      routeUnderTest,
-      applicationSetup,
-      specOverrides,
-      customTypes,
-      applicationEnvironmentBuilder
-    )
-    openApiTest(
-      snapshotName,
-      SupportedSerializer.GSON,
-      routeUnderTest,
-      applicationSetup,
-      specOverrides,
-      customTypes,
-      applicationEnvironmentBuilder
     )
   }
 
   private fun openApiTest(
     snapshotName: String,
-    serializer: SupportedSerializer,
+    routeUnderTest: Route.() -> Unit,
-    routeUnderTest: Routing.() -> Unit,
     applicationSetup: Application.() -> Unit,
     specOverrides: OpenApiSpec.() -> OpenApiSpec,
     typeOverrides: Map<KType, JsonSchema> = emptyMap(),
-    applicationBuilder: ApplicationEngineEnvironmentBuilder.() -> Unit = {}
+    notarizedApplicationConfigOverrides: NotarizedApplication.Config.() -> Unit,
+    contentNegotiation: ContentNegotiationConfig.() -> Unit,
+    applicationBuilder: ApplicationEnvironmentBuilder.() -> Unit,
+    serverConfigSetup: ServerConfigBuilder.() -> Unit
   ) = testApplication {
     environment(applicationBuilder)
     install(NotarizedApplication()) {
       customTypes = typeOverrides
-      spec = defaultSpec().specOverrides()
+      spec = { specOverrides(defaultSpec()) }
-      schemaConfigurator = when (serializer) {
+      schemaConfigurator = KotlinXSchemaConfigurator()
-        SupportedSerializer.KOTLINX -> KotlinXSchemaConfigurator()
+      notarizedApplicationConfigOverrides()
-        SupportedSerializer.GSON -> GsonSchemaConfigurator()
-        SupportedSerializer.JACKSON -> JacksonSchemaConfigurator()
-      }
     }
     install(ContentNegotiation) {
-      when (serializer) {
+      contentNegotiation()
-        SupportedSerializer.KOTLINX -> json(Json {
-          encodeDefaults = true
-          explicitNulls = false
-          serializersModule = KompendiumSerializersModule.module
-        })
-
-        SupportedSerializer.GSON -> gson()
-        SupportedSerializer.JACKSON -> jackson(ContentType.Application.Json) {
-          enable(SerializationFeature.INDENT_OUTPUT)
-          setSerializationInclusion(JsonInclude.Include.NON_NULL)
-        }
-      }
     }
     application(applicationSetup)
+    serverConfig(serverConfigSetup)
     routing {
       swagger()
       redoc()
       routeUnderTest()
     }
-    val root = ApplicationEngineEnvironmentBuilder().apply(applicationBuilder).rootPath
+
+    val root = ServerConfigBuilder(ApplicationEnvironmentBuilder().apply(applicationBuilder).build()).apply(serverConfigSetup).rootPath
     compareOpenAPISpec(root, snapshotName)
   }
 }

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

@@ -1,12 +1,10 @@
 package io.bkbn.kompendium.core.fixtures
 
-import com.fasterxml.jackson.annotation.JsonIgnore
-import com.fasterxml.jackson.annotation.JsonProperty
-import com.google.gson.annotations.Expose
-import com.google.gson.annotations.SerializedName
 import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable
 import kotlinx.serialization.Transient
+import kotlinx.serialization.encodeToString
+import kotlinx.serialization.json.Json
 import java.time.Instant
 
 @Serializable
@@ -25,7 +23,8 @@ data class TestRequest(
 @Serializable
 data class TestSimpleRequest(
   val a: String,
-  val b: Int
+  val b: Int,
+  val c: Boolean
 )
 
 @Serializable
@@ -91,6 +90,25 @@ data class AnothaJamma(val b: Float) : SlammaJamma
 
 data class InsaneJamma(val c: SlammaJamma) : SlammaJamma
 
+sealed interface ChillaxificationMaximization
+
+@Serializable
+@SerialName("chillax")
+data class Chillax(val a: String) : ChillaxificationMaximization
+
+@Serializable
+@SerialName("maximize")
+data class ToDaMax(val b: Int) : ChillaxificationMaximization
+
+sealed class Gadget(
+  open val title: String,
+  open val description: String
+)
+
+class Gizmo(
+  override val title: String,
+) : Gadget(title, "Just a gizmo")
+
 sealed interface Flibbity<T>
 
 data class Gibbity<T>(val a: T) : Flibbity<T>
@@ -158,9 +176,7 @@ object Nested {
 
 @Serializable
 data class TransientObject(
-  @field:Expose
   val nonTransient: String,
-  @field:JsonIgnore
   @Transient
   val transient: String = "transient"
 )
@@ -174,12 +190,14 @@ data class UnbackedObject(
 
 @Serializable
 data class SerialNameObject(
-  @field:JsonProperty("snake_case_name")
-  @field:SerializedName("snake_case_name")
   @SerialName("snake_case_name")
   val camelCaseName: String
 )
 
+data class GenericObject<T>(
+  val data: T
+)
+
 enum class Color {
   RED,
   GREEN,
@@ -190,3 +208,8 @@ enum class Color {
 data class ObjectWithEnum(
   val color: Color
 )
+
+@Serializable
+data class SomethingSimilar(val a: String) {
+  val b = "something else"
+}

detekt.yml

@@ -5,8 +5,8 @@ complexity:
     active: true
     functionThreshold: 10
     constructorThreshold: 15
-  ComplexMethod:
+  CyclomaticComplexMethod:
-    threshold: 20
+    threshold: 15
 style:
   MaxLineLength:
     excludes: ['**/test/**/*']
@@ -22,6 +22,8 @@ formatting:
     indentSize: 2
   ImportOrdering:
     active: false
+  EnumEntryNameCase:
+    active: false
 naming:
   ConstructorParameterNaming:
     active: false

docs/SUMMARY.md

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

docs/playground.md

@@ -12,7 +12,6 @@ At the moment, the following playground applications are
 | Gson         | Serialization using Gson instead of the default Kotlinx    |
 | Hidden Docs  | Place your generated documentation behind authorization    |
 | Jackson      | Serialization using Jackson instead of the default KotlinX |
-| Locations    | Using the Ktor Locations API to define routes              |
 | Resources    | Using the Ktor Resources API to define routes              |
 
 You can find all of the playground

docs/plugins/index.md

@@ -7,5 +7,5 @@ From there, a `NotarizedRoute` plugin is attached to each route you wish to docu
 be an iterative process. Each route you notarize will be picked up and injected into the OpenAPI spec that Kompendium
 generates for you.
 
-Finally, there is the `NotarizedLocations` plugin that allows you to leverage and document your usage of the
+Finally, there is the `NotarizedResources` plugin that allows you to leverage and document your usage of the
-Ktor [Locations](https://ktor.io/docs/locations.html) API.
+Ktor [Resources](https://ktor.io/docs/server-resources.html) API.

docs/plugins/notarized_locations.md

@@ -1,62 +0,0 @@
-The Ktor Locations API is an experimental API that allows users to add increased type safety to their defined routes.
-
-You can read more about it [here](https://ktor.io/docs/locations.html).
-
-Kompendium supports Locations through an ancillary module `kompendium-locations`
-
-## Adding the Artifact
-
-Prior to documenting your locations, you will need to add the artifact to your gradle build file.
-
-```kotlin
-dependencies {
-  implementation("io.bkbn:kompendium-locations:latest.release")
-}
-```
-
-## Installing Plugin
-
-Once you have installed the dependency, you can install the plugin. The `NotarizedLocations` plugin is an _application_
-level plugin, and **must** be install after both the `NotarizedApplication` plugin and the Ktor `Locations` plugin.
-
-```kotlin
-private fun Application.mainModule() {
-  install(Locations)
-  install(NotarizedApplication()) {
-    spec = baseSpec
-  }
-  install(NotarizedLocations()) {
-    locations = mapOf(
-      Listing::class to NotarizedLocations.LocationMetadata(
-        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 😱")
-          }
-        }
-      ),
-    )
-  }
-}
-```
-
-Here, the `locations` property is a map of `KClass<*>` to metadata describing that locations metadata. 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 `@Location` annotation, you will get a runtime
-> exception!

enrichment/build.gradle.kts

@@ -3,7 +3,7 @@ plugins {
   id("io.bkbn.sourdough.library.jvm")
   id("io.gitlab.arturbosch.detekt")
   id("com.adarshr.test-logger")
-  id("maven-publish")
+  id("com.vanniktech.maven.publish")
   id("java-library")
   id("signing")
   id("org.jetbrains.kotlinx.kover")

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

@@ -0,0 +1,16 @@
+package io.bkbn.kompendium.enrichment
+
+class BooleanEnrichment(override val id: String) : Enrichment {
+  override var deprecated: Boolean? = null
+  override var description: String? = null
+
+  companion object {
+    inline operator fun invoke(
+      id: String,
+      init: BooleanEnrichment.() -> Unit
+    ): BooleanEnrichment {
+      val builder = BooleanEnrichment(id)
+      return builder.apply(init)
+    }
+  }
+}

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

@@ -0,0 +1,24 @@
+package io.bkbn.kompendium.enrichment
+
+class CollectionEnrichment<T>(override val id: String) : TypeEnrichment<T> {
+
+  override var deprecated: Boolean? = null
+  override var description: String? = null
+
+  var maxItems: Int? = null
+  var minItems: Int? = null
+  var uniqueItems: Boolean? = null
+  // TODO How to handle contains, minContains, maxContains?
+
+  var itemEnrichment: TypeEnrichment<*>? = null
+
+  companion object {
+    inline operator fun <reified T> invoke(
+      id: String,
+      init: CollectionEnrichment<T>.() -> Unit
+    ): CollectionEnrichment<T> {
+      val builder = CollectionEnrichment<T>(id)
+      return builder.apply(init)
+    }
+  }
+}

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

@@ -1,3 +1,7 @@
 package io.bkbn.kompendium.enrichment
 
-sealed interface Enrichment
+sealed interface Enrichment {
+  val id: String
+  var deprecated: Boolean?
+  var description: String?
+}

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

@@ -0,0 +1,23 @@
+package io.bkbn.kompendium.enrichment
+
+class MapEnrichment<V>(override val id: String) : TypeEnrichment<V> {
+
+  override var deprecated: Boolean? = null
+  override var description: String? = null
+
+  var maxProperties: Int? = null
+  var minProperties: Int? = null
+
+  lateinit var keyEnrichment: StringEnrichment
+  lateinit var valueEnrichment: TypeEnrichment<*>
+
+  companion object {
+    inline operator fun <reified V> invoke(
+      id: String,
+      init: MapEnrichment<V>.() -> Unit
+    ): MapEnrichment<V> {
+      val builder = MapEnrichment<V>(id)
+      return builder.apply(init)
+    }
+  }
+}

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

@@ -0,0 +1,19 @@
+package io.bkbn.kompendium.enrichment
+class NumberEnrichment(override val id: String) : Enrichment {
+
+  override var deprecated: Boolean? = null
+  override var description: String? = null
+
+  var multipleOf: Number? = null
+  var maximum: Number? = null
+  var exclusiveMaximum: Number? = null
+  var minimum: Number? = null
+  var exclusiveMinimum: Number? = null
+
+  companion object {
+    inline operator fun invoke(id: String, init: NumberEnrichment.() -> Unit): NumberEnrichment {
+      val builder = NumberEnrichment(id)
+      return builder.apply(init)
+    }
+  }
+}

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

@@ -0,0 +1,27 @@
+package io.bkbn.kompendium.enrichment
+
+import kotlin.reflect.KProperty1
+
+class ObjectEnrichment<T>(override val id: String) : TypeEnrichment<T> {
+
+  override var deprecated: Boolean? = null
+  override var description: String? = null
+
+  private val _propertyEnrichments: MutableMap<KProperty1<*, *>, Enrichment> = mutableMapOf()
+
+  val propertyEnrichment: Map<KProperty1<*, *>, Enrichment>
+    get() = _propertyEnrichments.toMap()
+
+  operator fun <R> KProperty1<T, R>.invoke(init: () -> Enrichment) {
+    require(!_propertyEnrichments.containsKey(this)) { "${this.name} has already been registered" }
+    val enrichment = init.invoke()
+    _propertyEnrichments[this] = enrichment
+  }
+
+  companion object {
+    inline operator fun <reified T> invoke(id: String, init: ObjectEnrichment<T>.() -> Unit): ObjectEnrichment<T> {
+      val builder = ObjectEnrichment<T>(id)
+      return builder.apply(init)
+    }
+  }
+}

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

@@ -1,36 +0,0 @@
-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
-}