chore: prep for 3.9.0 release

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

.gitbook.yaml

@@ -0,0 +1 @@
+root: ./docs/

.github/workflows/pr_checks.yml

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

.github/workflows/publish.yml

@@ -11,8 +11,8 @@ jobs:
   publish:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
-      - uses: actions/setup-java@v2
+      - uses: actions/setup-java@v3
         with:
           distribution: 'adopt'
           java-version: '17'

.github/workflows/release.yml

@@ -11,12 +11,12 @@ jobs:
   publish-to-nexus:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
-      - uses: actions/setup-java@v2
+      - uses: actions/setup-java@v3
         with:
           distribution: 'adopt'
           java-version: '17'
-      - name: Publlish to Maven Central
+      - name: Publish to Maven Central
         uses: burrunan/gradle-cache-action@v1
         with:
           gradle-version: wrapper
@@ -26,28 +26,3 @@ jobs:
         env:
           ORG_GRADLE_PROJECT_sonatypeUsername: ${{ secrets.SONATYPE_USER }}
           ORG_GRADLE_PROJECT_sonatypePassword: ${{ secrets.SONATYPE_PASSWORD }}
-  build-documentation:
-    runs-on: ubuntu-latest
-    needs:
-      - publish-to-nexus
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
-      - uses: actions/setup-java@v2
-        with:
-          distribution: 'adopt'
-          java-version: '17'
-      - name: Build New Documentation
-        uses: burrunan/gradle-cache-action@v1
-        with:
-          gradle-version: wrapper
-          arguments: dokkaHtmlMultiModule
-          properties: |
-            release=true
-      - name: Push New Documentation
-        uses: EndBug/add-and-commit@v8
-        with:
-          default_author: github_actions
-          new_branch: main
-          message: 'doc: Added Latest Documentation ✨'

CHANGELOG.md

@@ -12,28 +12,215 @@
 
 ## Released
 
-## [2.0.4] - February 10th, 2022
+## [3.9.0] - November 15th, 2022
+
 ### Added
+
+- `protobuf-java-converter` module for converting generated protobuf objects to `JsonSchema` representations
+
+### Changed
+
+- Application `rootPath` is no longer prefixed to serialized route path when `NotarizedRoute` is resolved
+
+## [3.8.0] - November 9th, 2022
+
+### Added
+
+- Add support for NotarizedResource plugin scoped to route
+
+### Changed
+
+- Support registering same path with different authentication and methods
+
+## [3.7.0] - November 5th, 2022
+
+### Added
+
+- Allow users to override media type in request and response
+
+## [3.6.0] - November 5th, 2022
+
+### Changed
+
+- Schemas for types in nullable properties are no longer nullable themselves
+- Enums are now generated as references, which makes it possible to generate types for them
+
+## [3.5.0] - October 29th, 2022
+
+### Added
+
+- New `kompendium-resources` plugin to support Ktor Resources API
+
+## [3.4.0] - October 26th, 2022
+
+### Added
+
+- Support for custom docs path
+
+## [3.3.1] - September 26th, 2022
+
+### Added
+
+- Better exception thrown when unidentified type is encountered
+
+## [3.3.0] - September 15th, 2022
+
+### Added
+- Support for @Transient annotation
+- Support for @SerialName annotation on fields
+- Supports for un-backed fields, by excluding them from the generated schema.
+
+### Changed
+- Actually turned on detekt formatting 🤦
+- Removed some rouge print statements
+
+## Released
+
+## [3.2.0] - August 23rd, 2022
+
+### Added
+
+- `SchemaConfigurator` to allow for advanced json schema configuration such as field level overrides and transient
+  omission
+
+## [3.1.0] - August 18th, 2022
+
+### Added
+
+- Ability to automatically detect authentication via route
+
+### Fixed
+
+- Improved stack trace output
+
+## [3.0.0] - August 16th, 2022
+
+### Added
+
+- Ktor 2 Support 🎉
+- OpenAPI 3.1 Standard
+- JsonSchema Generator
+- `NotarizedRoute` plugin
+
+### Removed
+
+- SwaggerUI module removed (due to lack of OpenAPI 3.1 support)
+- Kompendium Annotations removed (field renames, undeclared fields, etc. will be follow-up work)
+
+## [2.3.5] - June 7th, 2022
+
+### Added
+
+### Changed
+
+- Fix serialization for api key location in api key auth configuration
+
+### Remove
+
+## [2.3.4] - April 7th, 2022
+
+### Changed
+
+- Put request body info now nullable
+
+## [2.3.3] - April 1st, 2022
+
+### Added
+
+- Added tests for Swagger UI module that verify that plugin generates correct responses for Swagger UI WEB resources (
+  tests should detect future incompatible changes in new versions of `org.webjars.swagger-ui`)
+
+### Changed
+
+- Fixed broken Swagger UI plugin (`org.webjars.swagger-ui` WEB resources structure changed in version 4.9.X).
+  Issue: https://github.com/bkbnio/kompendium/issues/236
+
+## [2.3.2] - March 30th, 2022
+
+### Changed
+
+- Fixed bug where nullable enum fields caused runtime exceptions
+
+## [2.3.1] - March 5th, 2022
+
+### Changed
+
+- Can now apply `@FreeFormObject` to top level types
+
+## [2.3.0] - March 1st, 2022
+
+### Added
+
+- Brand new SwaggerUI support as a KTor plugin with WebJar under the hood and flexible configuration
+
+### Changed
+
+- Playground example `SwaggerPlaygound` now demonstrates new SwaggerUI KTor plugin usage (including OAuth security)
+
+### Remove
+
+- Deprecated Swagger Webjar approach was removed from codebase
+
+## [2.2.1] - February 26th, 2022
+
+- Fix to support sealed class typed Maps
+
+## [2.2.0] - February 25th, 2022
+
+### Changed
+
+- Fixed support Location classes located in other non-location classes
+- Fixed formatting of a custom `SimpleSchema`
+- Multipart form-data multiple file request support
+
+## [2.1.1] - February 19th, 2022
+
+### Changed
+
+- Fixed sealed typed collections schema generation
+- Nullability no longer breaks object schema comparison
+
+## [2.1.0] - February 18th, 2022
+
+### Added
+
+- Ability to override serializer via custom route
+
+### Changed
+
+- All complex types are now represented by reference schemas
+- Deprecated `@Referenced` since all complex types now create references
+
+## [2.0.4] - February 10th, 2022
+
+### Added
+
 - Custom Type example to playground
 
 ### Changed
+
 - Cleaned up and broke out handlers into separate classes
 - Serializer cleanup
 - Tests now run against Jackson, Gson and kotlinx on every run
 - Swagger UI bumped from v3 to v4
 
 ## [2.0.3] - February 7th, 2022
+
 ### Changed
+
 - Fixed swagger documentation bug
 - Deprecated Swagger Webjar approach
 
 ## [2.0.2] - February 4th, 2022
+
 ### Added
+
 - `@Referenced` annotation enabling support for recursive models
 
 ## [2.0.1] - January 23rd, 2022
 
 ### Change
+
 - Fix bug in documentation publishing pipeline
 
 ## [2.0.0] - January 23rd, 2022

CONTRIBUTING.md

@@ -20,9 +20,7 @@ To get an overview of the project, read the [README](README.md). Here are some r
 
 ## Getting started
 
-The best way to get started with Kompendium is to read the [docs](https://bkbnio.github.io/kompendium).  Kompendium generates 
+The best way to get started with Kompendium is to read the [docs](https://bkbn.gitbook.io/kompendium). 
-our documentation using [Dokka](https://github.com/Kotlin/dokka).  This means that the docs live side-by-side with the source 
-code itself, and leverage the KDoc format to provide syntax highlighting, dynamic linking and more!
 
 If live examples are more your thing, inside the `kompendium-playground` module, you will find a collection of starter 
 examples ranging from simple CRUD and authentication examples, to more advanced topics like polymorphic serialization 

Project.md

@@ -1,41 +0,0 @@
-# Kompendium
-
-Welcome to Kompendium, the straight-forward, minimally-invasive OpenAPI generator for Ktor.  
-
-## How to install
-
-Kompendium publishes all releases to Maven Central. As such, using the release versions of `Kompendium` is as simple as
-declaring it as an implementation dependency in your `build.gradle.kts`
-
-```kotlin
-repositories {
-  mavenCentral()
-}
-
-dependencies {
-  implementation("io.bkbn:kompendium-core:latest.release")
-}
-```
-
-In addition to publishing releases to Maven Central, a snapshot version gets published to GitHub Packages on every merge
-to `main`. These can be consumed by adding the repository to your gradle build file. Instructions can be
-found [here](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry#using-a-published-package)
-
-## Setting up the Kompendium Plugin
-
-Kompendium is instantiated as a Ktor Feature/Plugin.  It can be added to your API as follows
-
-```kotlin
-private fun Application.mainModule() {
-    // Installs the Kompendium Plugin and sets up baseline server metadata
-    install(Kompendium) {
-        spec = OpenApiSpec(/*..*/)
-    }
-    // ...
-}
-```
-
-## Notarization
-
-The concept of notarizing routes / exceptions / etc. is central to Kompendium.  More details on _how_ to notarize your 
-API can be found in the kompendium-core module.

README.md

@@ -2,52 +2,4 @@
 
 [![version](https://img.shields.io/maven-central/v/io.bkbn/kompendium-core?style=flat-square)](https://search.maven.org/search?q=io.bkbn%20kompendium)
 
-## Table of Contents
+Documentation is stored in the `docs` folder and is hosted [here](https://bkbn.gitbook.io/kompendium)
-
-- [What Is Kompendium](#what-is-kompendium)
-- [How to Install](#how-to-install)
-- [Library Details](#library-details)
-- [Local Development](#local-development)
-- [The Playground](#the-playground)
-
-## What is Kompendium
-
-Kompendium is intended to be a minimally invasive OpenApi Specification generator for Ktor. Minimally invasive meaning
-that users will use only Ktor native functions when implementing their API, and will supplement with Kompendium code in
-order to generate the appropriate spec.
-
-## How to install
-
-Kompendium publishes all releases to Maven Central. As such, using the release versions of `Kompendium` is as simple as
-declaring it as an implementation dependency in your `build.gradle.kts`
-
-```kotlin
-repositories {
-  mavenCentral()
-}
-
-dependencies {
-  implementation("io.bkbn:kompendium-core:latest.release")
-}
-```
-
-In addition to publishing releases to Maven Central, a snapshot version gets published to GitHub Packages on every merge
-to `main`. These can be consumed by adding the repository to your gradle build file. Instructions can be
-found [here](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry#using-a-published-package)
-
-# Library Details
-
-Library documentation lives alongside the source code, and is generated into a static site via Dokka.  Can be viewed [here](https://bkbnio.github.io/kompendium)
-
-## Local Development
-
-Kompendium should run locally right out of the box, no configuration necessary (assuming you have JDK 11+ installed).
-New features can be built locally and published to your local maven repository with the `./gradlew publishToMavenLocal`
-command!
-
-## The Playground
-
-This repo contains a `playground` module that contains a number of working examples showcasing the capabilities of
-Kompendium.
-
-Feel free to check it out, or even create your own example!

build.gradle.kts

@@ -1,12 +1,11 @@
 plugins {
-  kotlin("jvm") version "1.6.10" apply false
+  kotlin("jvm") version "1.7.21" apply false
-  kotlin("plugin.serialization") version "1.6.10" apply false
+  kotlin("plugin.serialization") version "1.7.21" apply false
-  id("io.bkbn.sourdough.library.jvm") version "0.6.0" apply false
+  id("io.bkbn.sourdough.library.jvm") version "0.12.0" apply false
-  id("io.bkbn.sourdough.application.jvm") version "0.6.0" apply false
+  id("io.bkbn.sourdough.application.jvm") version "0.12.0" apply false
-  id("io.bkbn.sourdough.root") version "0.6.0"
+  id("io.bkbn.sourdough.root") version "0.12.0"
   id("com.github.jakemarsden.git-hooks") version "0.0.2"
-  id("org.jetbrains.dokka") version "1.6.10"
+  id("org.jetbrains.kotlinx.kover") version "0.6.1"
-  id("org.jetbrains.kotlinx.kover") version "0.5.0"
   id("io.github.gradle-nexus.publish-plugin") version "1.1.0"
 }
 

core/build.gradle.kts

@@ -0,0 +1,72 @@
+plugins {
+  kotlin("jvm")
+  kotlin("plugin.serialization")
+  id("io.bkbn.sourdough.library.jvm")
+  id("io.gitlab.arturbosch.detekt")
+  id("com.adarshr.test-logger")
+  id("maven-publish")
+  id("java-library")
+  id("signing")
+  id("java-test-fixtures")
+  id("org.jetbrains.kotlinx.kover")
+}
+
+sourdoughLibrary {
+  libraryName.set("Kompendium Core")
+  libraryDescription.set("Core functionality for the Kompendium library")
+  compilerArgs.set(listOf("-opt-in=kotlin.RequiresOptIn"))
+}
+
+dependencies {
+  // VERSIONS
+  val kotestVersion: String by project
+  val ktorVersion: String by project
+  val detektVersion: String by project
+
+  // IMPLEMENTATION
+
+  api(projects.kompendiumOas)
+  api(projects.kompendiumJsonSchema)
+
+  implementation("io.ktor:ktor-server-core:$ktorVersion")
+  implementation("io.ktor:ktor-server-cio:$ktorVersion")
+  implementation("io.ktor:ktor-server-html-builder:$ktorVersion")
+  implementation("io.ktor:ktor-server-content-negotiation:$ktorVersion")
+  implementation("io.ktor:ktor-serialization-kotlinx-json:$ktorVersion")
+  implementation("ch.qos.logback:logback-classic:1.4.4")
+
+  // Formatting
+  detektPlugins("io.gitlab.arturbosch.detekt:detekt-formatting:$detektVersion")
+
+  // TEST FIXTURES
+
+  testFixturesApi("io.kotest:kotest-runner-junit5-jvm:$kotestVersion")
+  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.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")
+  testFixturesApi("io.ktor:ktor-server-auth-jwt:$ktorVersion")
+  testFixturesApi("io.ktor:ktor-client:$ktorVersion")
+  testFixturesApi("io.ktor:ktor-client-cio:$ktorVersion")
+
+  testFixturesApi("dev.forst:ktor-api-key:2.1.3")
+
+  testFixturesApi("org.jetbrains.kotlinx:kotlinx-serialization-json:1.4.1")
+}
+
+testing {
+  suites {
+    named("test", JvmTestSuite::class) {
+      useJUnitJupiter()
+    }
+  }
+}

core/src/main/kotlin/io/bkbn/kompendium/core/attribute/KompendiumAttributes.kt

@@ -0,0 +1,10 @@
+package io.bkbn.kompendium.core.attribute
+
+import io.bkbn.kompendium.json.schema.SchemaConfigurator
+import io.bkbn.kompendium.oas.OpenApiSpec
+import io.ktor.util.AttributeKey
+
+object KompendiumAttributes {
+  val openApiSpec = AttributeKey<OpenApiSpec>("OpenApiSpec")
+  val schemaConfigurator = AttributeKey<SchemaConfigurator>("SchemaConfigurator")
+}

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

@@ -0,0 +1,39 @@
+package io.bkbn.kompendium.core.metadata
+
+import io.bkbn.kompendium.oas.common.ExternalDocumentation
+import io.bkbn.kompendium.oas.payload.Parameter
+
+class DeleteInfo private constructor(
+  override val response: ResponseInfo,
+  override val errors: MutableList<ResponseInfo>,
+  override val tags: Set<String>,
+  override val summary: String,
+  override val description: String,
+  override val externalDocumentation: ExternalDocumentation?,
+  override val operationId: String?,
+  override val deprecated: Boolean,
+  override val parameters: List<Parameter>
+) : MethodInfo {
+
+  companion object {
+    fun builder(init: Builder.() -> Unit): DeleteInfo {
+      val builder = Builder()
+      builder.init()
+      return builder.build()
+    }
+  }
+
+  class Builder : MethodInfo.Builder<DeleteInfo>() {
+    override fun build() = DeleteInfo(
+      response = response ?: error("Response info must be present"),
+      errors = errors,
+      tags = tags,
+      summary = summary ?: error("Summary must be present"),
+      description = description ?: error("Description must be present"),
+      externalDocumentation = externalDocumentation,
+      operationId = operationId,
+      deprecated = deprecated,
+      parameters = parameters
+    )
+  }
+}

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

@@ -0,0 +1,39 @@
+package io.bkbn.kompendium.core.metadata
+
+import io.bkbn.kompendium.oas.common.ExternalDocumentation
+import io.bkbn.kompendium.oas.payload.Parameter
+
+class GetInfo private constructor(
+  override val response: ResponseInfo,
+  override val errors: MutableList<ResponseInfo>,
+  override val tags: Set<String>,
+  override val summary: String,
+  override val description: String,
+  override val externalDocumentation: ExternalDocumentation?,
+  override val operationId: String?,
+  override val deprecated: Boolean,
+  override val parameters: List<Parameter>
+) : MethodInfo {
+
+  companion object {
+    fun builder(init: Builder.() -> Unit): GetInfo {
+      val builder = Builder()
+      builder.init()
+      return builder.build()
+    }
+  }
+
+  class Builder : MethodInfo.Builder<GetInfo>() {
+    override fun build() = GetInfo(
+      response = response ?: error("You must provide a response in order to notarize a GET"),
+      errors = errors,
+      tags = tags,
+      summary = summary ?: error("You must provide a summary in order to notarize a GET"),
+      description = description ?: error("You must provide a description in order to notarize a GET"),
+      externalDocumentation = externalDocumentation,
+      operationId = operationId,
+      deprecated = deprecated,
+      parameters = parameters
+    )
+  }
+}

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

@@ -0,0 +1,39 @@
+package io.bkbn.kompendium.core.metadata
+
+import io.bkbn.kompendium.oas.common.ExternalDocumentation
+import io.bkbn.kompendium.oas.payload.Parameter
+
+class HeadInfo private constructor(
+  override val response: ResponseInfo,
+  override val errors: MutableList<ResponseInfo>,
+  override val tags: Set<String>,
+  override val summary: String,
+  override val description: String,
+  override val externalDocumentation: ExternalDocumentation?,
+  override val operationId: String?,
+  override val deprecated: Boolean,
+  override val parameters: List<Parameter>
+) : MethodInfo {
+
+  companion object {
+    fun builder(init: Builder.() -> Unit): HeadInfo {
+      val builder = Builder()
+      builder.init()
+      return builder.build()
+    }
+  }
+
+  class Builder : MethodInfo.Builder<HeadInfo>() {
+    override fun build() = HeadInfo(
+      response = response ?: error("Response info must be present"),
+      errors = errors,
+      tags = tags,
+      summary = summary ?: error("Summary must be present"),
+      description = description ?: error("Description must be present"),
+      externalDocumentation = externalDocumentation,
+      operationId = operationId,
+      deprecated = deprecated,
+      parameters = parameters
+    )
+  }
+}

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

@@ -0,0 +1,64 @@
+package io.bkbn.kompendium.core.metadata
+
+import io.bkbn.kompendium.oas.common.ExternalDocumentation
+import io.bkbn.kompendium.oas.payload.Parameter
+
+sealed interface MethodInfo {
+  val response: ResponseInfo
+  val errors: List<ResponseInfo>
+  val tags: Set<String>
+  val summary: String
+  val description: String
+  val externalDocumentation: ExternalDocumentation?
+    get() = null
+  val operationId: String?
+    get() = null
+  val deprecated: Boolean
+    get() = false
+  val parameters: List<Parameter>
+    get() = emptyList()
+
+  abstract class Builder<T : MethodInfo> {
+    internal var response: ResponseInfo? = null
+    internal var summary: String? = null
+    internal var description: String? = null
+    internal var externalDocumentation: ExternalDocumentation? = null
+    internal var operationId: String? = null
+    internal var deprecated: Boolean = false
+    internal var tags: Set<String> = emptySet()
+    internal var parameters: List<Parameter> = emptyList()
+    internal var errors: MutableList<ResponseInfo> = mutableListOf()
+
+    fun response(init: ResponseInfo.Builder.() -> Unit) = apply {
+      val builder = ResponseInfo.Builder()
+      builder.init()
+      this.response = builder.build()
+    }
+
+    fun canRespond(init: ResponseInfo.Builder.() -> Unit) = apply {
+      val builder = ResponseInfo.Builder()
+      builder.init()
+      errors.add(builder.build())
+    }
+
+    fun canRespond(responses: List<ResponseInfo>) = apply {
+      errors.addAll(responses)
+    }
+
+    fun summary(s: String) = apply { this.summary = s }
+
+    fun description(s: String) = apply { this.description = s }
+
+    fun externalDocumentation(docs: ExternalDocumentation) = apply { this.externalDocumentation = docs }
+
+    fun operationId(id: String) = apply { this.operationId = id }
+
+    fun isDeprecated() = apply { this.deprecated = true }
+
+    fun tags(vararg tags: String) = apply { this.tags = tags.toSet() }
+
+    fun parameters(vararg parameters: Parameter) = apply { this.parameters = parameters.toList() }
+
+    abstract fun build(): T
+  }
+}

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

@@ -0,0 +1,15 @@
+package io.bkbn.kompendium.core.metadata
+
+sealed interface MethodInfoWithRequest : MethodInfo {
+  val request: RequestInfo
+
+  abstract class Builder<T : MethodInfoWithRequest> : MethodInfo.Builder<T>() {
+    internal var request: RequestInfo? = null
+
+    fun request(init: RequestInfo.Builder.() -> Unit) = apply {
+      val builder = RequestInfo.Builder()
+      builder.init()
+      this.request = builder.build()
+    }
+  }
+}

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

@@ -0,0 +1,39 @@
+package io.bkbn.kompendium.core.metadata
+
+import io.bkbn.kompendium.oas.common.ExternalDocumentation
+import io.bkbn.kompendium.oas.payload.Parameter
+
+class OptionsInfo private constructor(
+  override val response: ResponseInfo,
+  override val errors: MutableList<ResponseInfo>,
+  override val tags: Set<String>,
+  override val summary: String,
+  override val description: String,
+  override val externalDocumentation: ExternalDocumentation?,
+  override val operationId: String?,
+  override val deprecated: Boolean,
+  override val parameters: List<Parameter>
+) : MethodInfo {
+
+  companion object {
+    fun builder(init: Builder.() -> Unit): OptionsInfo {
+      val builder = Builder()
+      builder.init()
+      return builder.build()
+    }
+  }
+
+  class Builder : MethodInfo.Builder<OptionsInfo>() {
+    override fun build() = OptionsInfo(
+      response = response ?: error("Response info must be provided!"),
+      errors = errors,
+      tags = tags,
+      summary = summary ?: error("Summary must be provided!"),
+      description = description ?: error("Description must be provided!"),
+      externalDocumentation = externalDocumentation,
+      operationId = operationId,
+      deprecated = deprecated,
+      parameters = parameters
+    )
+  }
+}

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

@@ -0,0 +1,41 @@
+package io.bkbn.kompendium.core.metadata
+
+import io.bkbn.kompendium.oas.common.ExternalDocumentation
+import io.bkbn.kompendium.oas.payload.Parameter
+
+class PatchInfo private constructor(
+  override val request: RequestInfo,
+  override val errors: MutableList<ResponseInfo>,
+  override val response: ResponseInfo,
+  override val tags: Set<String>,
+  override val summary: String,
+  override val description: String,
+  override val externalDocumentation: ExternalDocumentation?,
+  override val operationId: String?,
+  override val deprecated: Boolean,
+  override val parameters: List<Parameter>
+) : MethodInfoWithRequest {
+
+  companion object {
+    fun builder(init: Builder.() -> Unit): PatchInfo {
+      val builder = Builder()
+      builder.init()
+      return builder.build()
+    }
+  }
+
+  class Builder : MethodInfoWithRequest.Builder<PatchInfo>() {
+    override fun build() = PatchInfo(
+      request = request ?: error("request info must be present"),
+      errors = errors,
+      response = response ?: error("response info must be present"),
+      tags = tags,
+      summary = summary ?: error("Summary must be present"),
+      description = description ?: error("Description must be present"),
+      externalDocumentation = externalDocumentation,
+      operationId = operationId,
+      deprecated = deprecated,
+      parameters = parameters
+    )
+  }
+}

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

@@ -0,0 +1,41 @@
+package io.bkbn.kompendium.core.metadata
+
+import io.bkbn.kompendium.oas.common.ExternalDocumentation
+import io.bkbn.kompendium.oas.payload.Parameter
+
+class PostInfo private constructor(
+  override val request: RequestInfo,
+  override val errors: MutableList<ResponseInfo>,
+  override val response: ResponseInfo,
+  override val tags: Set<String>,
+  override val summary: String,
+  override val description: String,
+  override val externalDocumentation: ExternalDocumentation?,
+  override val operationId: String?,
+  override val deprecated: Boolean,
+  override val parameters: List<Parameter>
+) : MethodInfoWithRequest {
+
+  companion object {
+    fun builder(init: Builder.() -> Unit): PostInfo {
+      val builder = Builder()
+      builder.init()
+      return builder.build()
+    }
+  }
+
+  class Builder : MethodInfoWithRequest.Builder<PostInfo>() {
+    override fun build() = PostInfo(
+      request = request ?: error("request info must be present"),
+      errors = errors,
+      response = response ?: error("response info must be present"),
+      tags = tags,
+      summary = summary ?: error("Summary must be present"),
+      description = description ?: error("Description must be present"),
+      externalDocumentation = externalDocumentation,
+      operationId = operationId,
+      deprecated = deprecated,
+      parameters = parameters
+    )
+  }
+}

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

@@ -0,0 +1,41 @@
+package io.bkbn.kompendium.core.metadata
+
+import io.bkbn.kompendium.oas.common.ExternalDocumentation
+import io.bkbn.kompendium.oas.payload.Parameter
+
+class PutInfo private constructor(
+  override val request: RequestInfo,
+  override val errors: MutableList<ResponseInfo>,
+  override val response: ResponseInfo,
+  override val tags: Set<String>,
+  override val summary: String,
+  override val description: String,
+  override val externalDocumentation: ExternalDocumentation?,
+  override val operationId: String?,
+  override val deprecated: Boolean,
+  override val parameters: List<Parameter>
+) : MethodInfoWithRequest {
+
+  companion object {
+    fun builder(init: Builder.() -> Unit): PutInfo {
+      val builder = Builder()
+      builder.init()
+      return builder.build()
+    }
+  }
+
+  class Builder : MethodInfoWithRequest.Builder<PutInfo>() {
+    override fun build() = PutInfo(
+      request = request ?: error("request info must be present"),
+      errors = errors,
+      response = response ?: error("response info must be present"),
+      tags = tags,
+      summary = summary ?: error("Summary must be present"),
+      description = description ?: error("Description must be present"),
+      externalDocumentation = externalDocumentation,
+      operationId = operationId,
+      deprecated = deprecated,
+      parameters = parameters
+    )
+  }
+}

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

@@ -0,0 +1,51 @@
+package io.bkbn.kompendium.core.metadata
+
+import io.bkbn.kompendium.oas.payload.MediaType
+import kotlin.reflect.KType
+import kotlin.reflect.typeOf
+
+class RequestInfo private constructor(
+  val requestType: KType,
+  val description: String,
+  val examples: Map<String, MediaType.Example>?,
+  val mediaTypes: Set<String>
+) {
+
+  companion object {
+    fun builder(init: Builder.() -> Unit): RequestInfo {
+      val builder = Builder()
+      builder.init()
+      return builder.build()
+    }
+  }
+
+  class Builder {
+    private var requestType: KType? = null
+    private var description: String? = null
+    private var examples: Map<String, MediaType.Example>? = null
+    private var mediaTypes: Set<String>? = null
+
+    fun requestType(t: KType) = apply {
+      this.requestType = t
+    }
+
+    inline fun <reified T> requestType() = apply { requestType(typeOf<T>()) }
+
+    fun description(s: String) = apply { this.description = s }
+
+    fun examples(vararg e: Pair<String, Any>) = apply {
+      this.examples = e.toMap().mapValues { (_, v) -> MediaType.Example(v) }
+    }
+
+    fun mediaTypes(vararg m: String) = apply {
+      this.mediaTypes = m.toSet()
+    }
+
+    fun build() = RequestInfo(
+      requestType = requestType ?: error("Request type must be present"),
+      description = description ?: error("Description must be present"),
+      examples = examples,
+      mediaTypes = mediaTypes ?: setOf("application/json")
+    )
+  }
+}

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

@@ -0,0 +1,59 @@
+package io.bkbn.kompendium.core.metadata
+
+import io.bkbn.kompendium.oas.payload.MediaType
+import io.ktor.http.HttpStatusCode
+import kotlin.reflect.KType
+import kotlin.reflect.typeOf
+
+class ResponseInfo private constructor(
+  val responseCode: HttpStatusCode,
+  val responseType: KType,
+  val description: String,
+  val examples: Map<String, MediaType.Example>?,
+  val mediaTypes: Set<String>
+) {
+
+  companion object {
+    fun builder(init: Builder.() -> Unit): ResponseInfo {
+      val builder = Builder()
+      builder.init()
+      return builder.build()
+    }
+  }
+
+  class Builder {
+    private var responseCode: HttpStatusCode? = null
+    private var responseType: KType? = null
+    private var description: String? = null
+    private var examples: Map<String, MediaType.Example>? = null
+    private var mediaTypes: Set<String>? = null
+
+    fun responseCode(code: HttpStatusCode) = apply {
+      this.responseCode = code
+    }
+
+    fun responseType(t: KType) = apply {
+      this.responseType = t
+    }
+
+    inline fun <reified T> responseType() = apply { responseType(typeOf<T>()) }
+
+    fun description(s: String) = apply { this.description = s }
+
+    fun examples(vararg e: Pair<String, Any>) = apply {
+      this.examples = e.toMap().mapValues { (_, v) -> MediaType.Example(v) }
+    }
+
+    fun mediaTypes(vararg m: String) = apply {
+      this.mediaTypes = m.toSet()
+    }
+
+    fun build() = ResponseInfo(
+      responseCode = responseCode ?: error("You must provide a response code in order to build a Response!"),
+      responseType = responseType ?: error("You must provide a response type in order to build a Response!"),
+      description = description ?: error("You must provide a description in order to build a Response!"),
+      examples = examples,
+      mediaTypes = mediaTypes ?: setOf("application/json")
+    )
+  }
+}

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

@@ -0,0 +1,47 @@
+package io.bkbn.kompendium.core.plugin
+
+import io.bkbn.kompendium.core.attribute.KompendiumAttributes
+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
+import kotlin.reflect.KType
+
+object NotarizedApplication {
+
+  class Config {
+    lateinit var spec: OpenApiSpec
+    var openApiJson: Routing.() -> Unit = {
+      route("/openapi.json") {
+        get {
+          call.respond(HttpStatusCode.OK, this@route.application.attributes[KompendiumAttributes.openApiSpec])
+        }
+      }
+    }
+    var customTypes: Map<KType, JsonSchema> = emptyMap()
+    var schemaConfigurator: SchemaConfigurator = SchemaConfigurator.Default()
+  }
+
+  operator fun invoke() = createApplicationPlugin(
+    name = "NotarizedApplication",
+    createConfiguration = ::Config
+  ) {
+    val spec = pluginConfig.spec
+    val routing = application.routing { }
+    pluginConfig.openApiJson(routing)
+    pluginConfig.customTypes.forEach { (type, schema) ->
+      spec.components.schemas[type.getSimpleSlug()] = schema
+    }
+    application.attributes.put(KompendiumAttributes.openApiSpec, spec)
+    application.attributes.put(KompendiumAttributes.schemaConfigurator, pluginConfig.schemaConfigurator)
+  }
+}

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

@@ -0,0 +1,96 @@
+package io.bkbn.kompendium.core.plugin
+
+import io.bkbn.kompendium.core.attribute.KompendiumAttributes
+import io.bkbn.kompendium.core.metadata.DeleteInfo
+import io.bkbn.kompendium.core.metadata.GetInfo
+import io.bkbn.kompendium.core.metadata.HeadInfo
+import io.bkbn.kompendium.core.metadata.OptionsInfo
+import io.bkbn.kompendium.core.metadata.PatchInfo
+import io.bkbn.kompendium.core.metadata.PostInfo
+import io.bkbn.kompendium.core.metadata.PutInfo
+import io.bkbn.kompendium.core.util.Helpers.addToSpec
+import io.bkbn.kompendium.core.util.SpecConfig
+import io.bkbn.kompendium.oas.OpenApiSpec
+import io.bkbn.kompendium.oas.path.Path
+import io.bkbn.kompendium.oas.payload.Parameter
+import io.ktor.server.application.ApplicationCallPipeline
+import io.ktor.server.application.Hook
+import io.ktor.server.application.PluginBuilder
+import io.ktor.server.application.createRouteScopedPlugin
+import io.ktor.server.routing.Route
+import io.ktor.server.routing.application
+
+object NotarizedRoute {
+  class Config : SpecConfig {
+    override var tags: Set<String> = emptySet()
+    override var parameters: List<Parameter> = emptyList()
+    override var get: GetInfo? = null
+    override var post: PostInfo? = null
+    override var put: PutInfo? = null
+    override var delete: DeleteInfo? = null
+    override var patch: PatchInfo? = null
+    override var head: HeadInfo? = null
+    override var options: OptionsInfo? = null
+    override var security: Map<String, List<String>>? = null
+  }
+
+  private object InstallHook : Hook<(ApplicationCallPipeline) -> Unit> {
+    override fun install(pipeline: ApplicationCallPipeline, handler: (ApplicationCallPipeline) -> Unit) {
+      handler(pipeline)
+    }
+  }
+
+  operator fun invoke() = createRouteScopedPlugin(
+    name = "NotarizedRoute",
+    createConfiguration = ::Config
+  ) {
+    // This is required in order to introspect the route path and authentication
+    on(InstallHook) {
+      val route = it as? Route ?: return@on
+      val spec = application.attributes[KompendiumAttributes.openApiSpec]
+      val routePath = route.calculateRoutePath()
+      val authMethods = route.collectAuthMethods()
+
+      addToSpec(spec, routePath, authMethods)
+    }
+  }
+
+  fun <T : SpecConfig> PluginBuilder<T>.addToSpec(
+    spec: OpenApiSpec,
+    fullPath: String,
+    authMethods: List<String>
+  ) {
+    val path = spec.paths[fullPath] ?: Path()
+
+    path.parameters = path.parameters?.plus(pluginConfig.parameters) ?: pluginConfig.parameters
+    val serializableReader = application.attributes[KompendiumAttributes.schemaConfigurator]
+
+    pluginConfig.get?.addToSpec(path, spec, pluginConfig, serializableReader, fullPath, authMethods)
+    pluginConfig.delete?.addToSpec(path, spec, pluginConfig, serializableReader, fullPath, authMethods)
+    pluginConfig.head?.addToSpec(path, spec, pluginConfig, serializableReader, fullPath, authMethods)
+    pluginConfig.options?.addToSpec(path, spec, pluginConfig, serializableReader, fullPath, authMethods)
+    pluginConfig.post?.addToSpec(path, spec, pluginConfig, serializableReader, fullPath, authMethods)
+    pluginConfig.put?.addToSpec(path, spec, pluginConfig, serializableReader, fullPath, authMethods)
+    pluginConfig.patch?.addToSpec(path, spec, pluginConfig, serializableReader, fullPath, authMethods)
+
+    spec.paths[fullPath] = path
+  }
+
+  fun Route.calculateRoutePath() = toString()
+    .let {
+      application.environment.rootPath.takeIf { root -> root.isNotEmpty() }
+        ?.let { root ->
+          val sanitizedRoute = if (root.startsWith("/")) root else "/$root"
+          it.replace(sanitizedRoute, "")
+        }
+        ?: it
+    }
+    .replace(Regex("/\\(.+\\)"), "")
+
+  fun Route.collectAuthMethods() = toString()
+    .split("/")
+    .filter { it.contains(Regex("\\(authenticate .*\\)")) }
+    .map { it.replace("(authenticate ", "").replace(")", "") }
+    .map { it.split(", ") }
+    .flatten()
+}

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

@@ -1,10 +1,11 @@
 package io.bkbn.kompendium.core.routes
 
-import io.ktor.application.call
+import io.ktor.http.HttpStatusCode
-import io.ktor.html.respondHtml
+import io.ktor.server.application.call
-import io.ktor.routing.Routing
+import io.ktor.server.html.respondHtml
-import io.ktor.routing.get
+import io.ktor.server.routing.Route
-import io.ktor.routing.route
+import io.ktor.server.routing.get
+import io.ktor.server.routing.route
 import kotlinx.html.body
 import kotlinx.html.head
 import kotlinx.html.link
@@ -15,14 +16,15 @@ import kotlinx.html.title
 import kotlinx.html.unsafe
 
 /**
- * Provides an out-of-the-box route to view docs using ReDoc
+ * Provides an out-of-the-box route to view docs using ReDoc on the specified [path].
  * @param pageTitle Webpage title you wish to be displayed on your docs
+ * @param route path to docs resource
  * @param specUrl url to point ReDoc to the OpenAPI json document
  */
-fun Routing.redoc(pageTitle: String = "Docs", specUrl: String = "/openapi.json") {
+fun Route.redoc(pageTitle: String = "Docs", path: String = "/docs", specUrl: String = "/openapi.json") {
-  route("/docs") {
+  route(path) {
     get {
-      call.respondHtml {
+      call.respondHtml(HttpStatusCode.OK) {
         head {
           title {
             +pageTitle
@@ -45,7 +47,7 @@ fun Routing.redoc(pageTitle: String = "Docs", specUrl: String = "/openapi.json")
           }
         }
         body {
-          unsafe { +"<redoc spec-url='${specUrl}'></redoc>" }
+          unsafe { +"<redoc spec-url='$specUrl'></redoc>" }
           script {
             src = "https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"
           }

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

@@ -0,0 +1,154 @@
+package io.bkbn.kompendium.core.util
+
+import io.bkbn.kompendium.core.metadata.DeleteInfo
+import io.bkbn.kompendium.core.metadata.GetInfo
+import io.bkbn.kompendium.core.metadata.HeadInfo
+import io.bkbn.kompendium.core.metadata.MethodInfo
+import io.bkbn.kompendium.core.metadata.MethodInfoWithRequest
+import io.bkbn.kompendium.core.metadata.OptionsInfo
+import io.bkbn.kompendium.core.metadata.PatchInfo
+import io.bkbn.kompendium.core.metadata.PostInfo
+import io.bkbn.kompendium.core.metadata.PutInfo
+import io.bkbn.kompendium.core.metadata.ResponseInfo
+import io.bkbn.kompendium.json.schema.SchemaConfigurator
+import io.bkbn.kompendium.json.schema.SchemaGenerator
+import io.bkbn.kompendium.json.schema.definition.NullableDefinition
+import io.bkbn.kompendium.json.schema.definition.OneOfDefinition
+import io.bkbn.kompendium.json.schema.definition.ReferenceDefinition
+import io.bkbn.kompendium.json.schema.util.Helpers.getReferenceSlug
+import io.bkbn.kompendium.json.schema.util.Helpers.getSimpleSlug
+import io.bkbn.kompendium.oas.OpenApiSpec
+import io.bkbn.kompendium.oas.path.Path
+import io.bkbn.kompendium.oas.path.PathOperation
+import io.bkbn.kompendium.oas.payload.MediaType
+import io.bkbn.kompendium.oas.payload.Request
+import io.bkbn.kompendium.oas.payload.Response
+import kotlin.reflect.KClass
+import kotlin.reflect.KMutableProperty1
+import kotlin.reflect.KType
+
+object Helpers {
+
+  private fun PathOperation.addDefaultAuthMethods(methods: List<String>) {
+    methods.forEach { m ->
+      if (security == null || security?.all { s -> !s.containsKey(m) } == true) {
+        if (security == null) {
+          security = mutableListOf(mapOf(m to emptyList()))
+        } else {
+          security?.add(mapOf(m to emptyList()))
+        }
+      }
+    }
+  }
+
+  fun MethodInfo.addToSpec(
+    path: Path,
+    spec: OpenApiSpec,
+    config: SpecConfig,
+    schemaConfigurator: SchemaConfigurator,
+    routePath: String,
+    authMethods: List<String> = emptyList()
+  ) {
+    SchemaGenerator.fromTypeOrUnit(
+      this.response.responseType,
+      spec.components.schemas, schemaConfigurator
+    )?.let { schema ->
+      spec.components.schemas[this.response.responseType.getSimpleSlug()] = schema
+    }
+
+    errors.forEach { error ->
+      SchemaGenerator.fromTypeOrUnit(error.responseType, spec.components.schemas, schemaConfigurator)?.let { schema ->
+        spec.components.schemas[error.responseType.getSimpleSlug()] = schema
+      }
+    }
+
+    when (this) {
+      is MethodInfoWithRequest -> {
+        SchemaGenerator.fromTypeOrUnit(
+          this.request.requestType,
+          spec.components.schemas,
+          schemaConfigurator
+        )?.let { schema ->
+          spec.components.schemas[this.request.requestType.getSimpleSlug()] = schema
+        }
+      }
+
+      else -> {}
+    }
+
+    val operations = this.toPathOperation(config)
+    operations.addDefaultAuthMethods(authMethods)
+
+    fun setOperation(
+      property: KMutableProperty1<Path, PathOperation?>
+    ) {
+      require(property.get(path) == null) {
+        "A route has already been registered for path: $routePath and method: ${property.name.uppercase()}"
+      }
+      property.set(path, operations)
+    }
+
+    return when (this) {
+      is DeleteInfo -> setOperation(Path::delete)
+      is GetInfo -> setOperation(Path::get)
+      is HeadInfo -> setOperation(Path::head)
+      is PatchInfo -> setOperation(Path::patch)
+      is PostInfo -> setOperation(Path::post)
+      is PutInfo -> setOperation(Path::put)
+      is OptionsInfo -> setOperation(Path::options)
+    }
+  }
+
+  private fun MethodInfo.toPathOperation(config: SpecConfig) = PathOperation(
+    tags = config.tags.plus(this.tags),
+    summary = this.summary,
+    description = this.description,
+    externalDocs = this.externalDocumentation,
+    operationId = this.operationId,
+    deprecated = this.deprecated,
+    parameters = this.parameters,
+    security = config.security
+      ?.map { (k, v) -> k to v }
+      ?.map { listOf(it).toMap() }
+      ?.toMutableList(),
+    requestBody = when (this) {
+      is MethodInfoWithRequest -> Request(
+        description = this.request.description,
+        content = this.request.requestType.toReferenceContent(this.request.examples, this.request.mediaTypes),
+        required = true
+      )
+
+      else -> null
+    },
+    responses = mapOf(
+      this.response.responseCode.value to Response(
+        description = this.response.description,
+        content = this.response.responseType.toReferenceContent(this.response.examples, this.response.mediaTypes)
+      )
+    ).plus(this.errors.toResponseMap())
+  )
+
+  private fun List<ResponseInfo>.toResponseMap(): Map<Int, Response> = associate { error ->
+    error.responseCode.value to Response(
+      description = error.description,
+      content = error.responseType.toReferenceContent(error.examples, error.mediaTypes)
+    )
+  }
+
+  private fun KType.toReferenceContent(
+    examples: Map<String, MediaType.Example>?,
+    mediaTypes: Set<String>
+  ): Map<String, MediaType>? =
+    when (this.classifier as KClass<*>) {
+      Unit::class -> null
+      else -> mediaTypes.associateWith {
+        MediaType(
+          schema = if (this.isMarkedNullable) OneOfDefinition(
+            NullableDefinition(),
+            ReferenceDefinition(this.getReferenceSlug())
+          ) else ReferenceDefinition(this.getReferenceSlug()),
+          examples = examples
+        )
+      }
+    }
+}

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

@@ -0,0 +1,23 @@
+package io.bkbn.kompendium.core.util
+
+import io.bkbn.kompendium.core.metadata.DeleteInfo
+import io.bkbn.kompendium.core.metadata.GetInfo
+import io.bkbn.kompendium.core.metadata.HeadInfo
+import io.bkbn.kompendium.core.metadata.OptionsInfo
+import io.bkbn.kompendium.core.metadata.PatchInfo
+import io.bkbn.kompendium.core.metadata.PostInfo
+import io.bkbn.kompendium.core.metadata.PutInfo
+import io.bkbn.kompendium.oas.payload.Parameter
+
+interface SpecConfig {
+  var tags: Set<String>
+  var parameters: List<Parameter>
+  var get: GetInfo?
+  var post: PostInfo?
+  var put: PutInfo?
+  var delete: DeleteInfo?
+  var patch: PatchInfo?
+  var head: HeadInfo?
+  var options: OptionsInfo?
+  var security: Map<String, List<String>>?
+}

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

@@ -0,0 +1,417 @@
+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.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.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.multipleAuthStrategies
+import io.bkbn.kompendium.core.util.multipleExceptions
+import io.bkbn.kompendium.core.util.nestedGenericCollection
+import io.bkbn.kompendium.core.util.nestedGenericMultipleParamsCollection
+import io.bkbn.kompendium.core.util.nestedGenericResponse
+import io.bkbn.kompendium.core.util.nestedTypeName
+import io.bkbn.kompendium.core.util.nestedUnderRoot
+import io.bkbn.kompendium.core.util.nonRequiredParam
+import io.bkbn.kompendium.core.util.nonRequiredParams
+import io.bkbn.kompendium.core.util.notarizedDelete
+import io.bkbn.kompendium.core.util.notarizedGet
+import io.bkbn.kompendium.core.util.notarizedHead
+import io.bkbn.kompendium.core.util.notarizedOptions
+import io.bkbn.kompendium.core.util.notarizedPatch
+import io.bkbn.kompendium.core.util.notarizedPost
+import io.bkbn.kompendium.core.util.notarizedPut
+import io.bkbn.kompendium.core.util.nullableEnumField
+import io.bkbn.kompendium.core.util.nullableField
+import io.bkbn.kompendium.core.util.nullableNestedObject
+import io.bkbn.kompendium.core.util.nullableReference
+import io.bkbn.kompendium.core.util.overrideMediaTypes
+import io.bkbn.kompendium.core.util.polymorphicCollectionResponse
+import io.bkbn.kompendium.core.util.polymorphicException
+import io.bkbn.kompendium.core.util.polymorphicMapResponse
+import io.bkbn.kompendium.core.util.polymorphicResponse
+import io.bkbn.kompendium.core.util.primitives
+import io.bkbn.kompendium.core.util.reqRespExamples
+import io.bkbn.kompendium.core.util.requiredParams
+import io.bkbn.kompendium.core.util.returnsList
+import io.bkbn.kompendium.core.util.rootRoute
+import io.bkbn.kompendium.core.util.samePathDifferentMethodsAndAuth
+import io.bkbn.kompendium.core.util.samePathSameMethod
+import io.bkbn.kompendium.core.util.simpleGenericResponse
+import io.bkbn.kompendium.core.util.simplePathParsing
+import io.bkbn.kompendium.core.util.simpleRecursive
+import io.bkbn.kompendium.core.util.singleException
+import io.bkbn.kompendium.core.util.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.security.OAuth
+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.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.auth.oauth
+import java.net.URI
+import java.time.Instant
+import kotlin.reflect.typeOf
+
+class KompendiumTest : DescribeSpec({
+  describe("Notarized Open API Metadata Tests") {
+    it("Can notarize a get request") {
+      openApiTestAllSerializers("T0001__notarized_get.json") { notarizedGet() }
+    }
+    it("Can notarize a post request") {
+      openApiTestAllSerializers("T0002__notarized_post.json") { notarizedPost() }
+    }
+    it("Can notarize a put request") {
+      openApiTestAllSerializers("T0003__notarized_put.json") { notarizedPut() }
+    }
+    it("Can notarize a delete request") {
+      openApiTestAllSerializers("T0004__notarized_delete.json") { notarizedDelete() }
+    }
+    it("Can notarize a patch request") {
+      openApiTestAllSerializers("T0005__notarized_patch.json") { notarizedPatch() }
+    }
+    it("Can notarize a head request") {
+      openApiTestAllSerializers("T0006__notarized_head.json") { notarizedHead() }
+    }
+    it("Can notarize an options request") {
+      openApiTestAllSerializers("T0007__notarized_options.json") { notarizedOptions() }
+    }
+    it("Can notarize a complex type") {
+      openApiTestAllSerializers("T0008__complex_type.json") { complexRequest() }
+    }
+    it("Can notarize primitives") {
+      openApiTestAllSerializers("T0009__notarized_primitives.json") { primitives() }
+    }
+    it("Can notarize a top level list response") {
+      openApiTestAllSerializers("T0010__response_list.json") { returnsList() }
+    }
+    it("Can notarize a route with non-required params") {
+      openApiTestAllSerializers("T0011__non_required_params.json") { nonRequiredParams() }
+    }
+    it("Can override media types") {
+      openApiTestAllSerializers("T0052__override_media_types.json") { overrideMediaTypes() }
+    }
+  }
+  describe("Route Parsing") {
+    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") {
+      openApiTestAllSerializers("T0013__root_route.json") { rootRoute() }
+    }
+    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") {
+    it("Marks a parameter as required if there is no default and it is not marked nullable") {
+      openApiTestAllSerializers("T0023__required_param.json") { requiredParams() }
+    }
+    it("Can mark a parameter as not required") {
+      openApiTestAllSerializers("T0024__non_required_param.json") { nonRequiredParam() }
+    }
+    it("Does not mark a field as required if a default value is provided") {
+      openApiTestAllSerializers("T0025__default_field.json") { defaultField() }
+    }
+    it("Does not mark a nullable field as required") {
+      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() }
+    }
+    it("Can support un-backed fields") {
+      openApiTestAllSerializers("T0049__unbacked_property.json") { unbackedFieldsResponse() }
+    }
+    it("Can support custom named fields") {
+      openApiTestAllSerializers("T0050__custom_named_property.json") { customFieldNameResponse() }
+    }
+  }
+  describe("Miscellaneous") {
+    xit("Can generate the necessary ReDoc home page") {
+      // TODO apiFunctionalityTest(getFileSnapshot("redoc.html"), "/docs") { returnsList() }
+    }
+    it("Can add an operation id to a notarized route") {
+      openApiTestAllSerializers("T0034__notarized_get_with_operation_id.json") { withOperationId() }
+    }
+    xit("Can add an undeclared field") {
+      // TODO openApiTestAllSerializers("undeclared_field.json") { undeclaredType() }
+    }
+    it("Can add a custom header parameter with a name override") {
+      openApiTestAllSerializers("T0035__override_parameter_name.json") { headerParameter() }
+    }
+    xit("Can override field name") {
+      // TODO Assess strategies here
+    }
+    it("Can serialize a recursive type") {
+      openApiTestAllSerializers("T0042__simple_recursive.json") { simpleRecursive() }
+    }
+    it("Nullable fields do not lead to doom") {
+      openApiTestAllSerializers("T0036__nullable_fields.json") { nullableNestedObject() }
+    }
+    it("Can have a nullable enum as a member field") {
+      openApiTestAllSerializers("T0037__nullable_enum_field.json") { nullableEnumField() }
+    }
+    it("Can have a nullable reference without impacting base type") {
+      openApiTestAllSerializers("T0041__nullable_reference.json") { nullableReference() }
+    }
+    it("Can handle nested type names") {
+      openApiTestAllSerializers("T0044__nested_type_name.json") { nestedTypeName() }
+    }
+    it("Can handle top level nullable types") {
+      openApiTestAllSerializers("T0051__top_level_nullable.json") { topLevelNullable() }
+    }
+    it("Can handle multiple registrations for different methods with the same path and different auth") {
+      openApiTestAllSerializers(
+        "T0053__same_path_different_methods_and_auth.json",
+        applicationSetup = {
+          install(Authentication) {
+            basic("basic") {
+              realm = "Ktor Server"
+              validate { UserIdPrincipal("Placeholder") }
+            }
+          }
+        },
+        specOverrides = {
+          this.copy(
+            components = Components(
+              securitySchemes = mutableMapOf(
+                "basic" to BasicAuth()
+              )
+            )
+          )
+        }
+      ) { samePathDifferentMethodsAndAuth() }
+    }
+    it("Can generate paths without application root-path") {
+      openApiTestAllSerializers(
+        "T0054__app_with_rootpath.json",
+        applicationEnvironmentBuilder = {
+          rootPath = "/example"
+        },
+        specOverrides = {
+          copy(
+            servers = servers.map { it.copy(url = URI("${it.url}/example")) }.toMutableList()
+          )
+        }
+      ) { notarizedGet() }
+    }
+  }
+  describe("Error Handling") {
+    it("Throws a clear exception when an unidentified type is encountered") {
+      val exception = shouldThrow<UnknownSchemaException> { openApiTestAllSerializers("") { dateTimeString() } }
+      exception.message should startWith("An unknown type was encountered: class java.time.Instant")
+    }
+    it("Throws an exception when same method for same path has been previously registered") {
+      val exception = shouldThrow<IllegalArgumentException> {
+        openApiTestAllSerializers("") {
+          samePathSameMethod()
+        }
+      }
+      exception.message should startWith("A route has already been registered for path: /test/{a} and method: GET")
+    }
+  }
+  describe("Constraints") {
+    // TODO Assess strategies here
+  }
+  describe("Formats") {
+    it("Can set a format for a simple type schema") {
+      openApiTestAllSerializers(
+        snapshotName = "T0038__formatted_date_time_string.json",
+        customTypes = mapOf(typeOf<Instant>() to TypeDefinition(type = "string", format = "date"))
+      ) { dateTimeString() }
+    }
+  }
+  describe("Free Form") {
+    // todo Assess strategies here
+  }
+  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 = {
+          this.copy(
+            components = Components(
+              securitySchemes = mutableMapOf(
+                "jwt" to BearerAuth("JWT"),
+                "api-key" to ApiKeyAuth(ApiKeyAuth.ApiKeyLocation.HEADER, "X-API-KEY")
+              )
+            )
+          )
+        }
+      ) { multipleAuthStrategies() }
+    }
+  }
+})

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,57 @@
+package io.bkbn.kompendium.core.util
+
+import io.bkbn.kompendium.core.fixtures.TestNested
+import io.bkbn.kompendium.core.fixtures.TestRequest
+import io.bkbn.kompendium.core.fixtures.TestResponse
+import io.bkbn.kompendium.core.metadata.PostInfo
+import io.bkbn.kompendium.core.plugin.NotarizedRoute
+import io.bkbn.kompendium.core.util.TestModules.defaultPathDescription
+import io.bkbn.kompendium.core.util.TestModules.defaultPathSummary
+import io.bkbn.kompendium.core.util.TestModules.defaultRequestDescription
+import io.bkbn.kompendium.core.util.TestModules.defaultResponseDescription
+import io.bkbn.kompendium.core.util.TestModules.rootPath
+import io.bkbn.kompendium.json.schema.definition.TypeDefinition
+import io.bkbn.kompendium.oas.payload.Parameter
+import io.ktor.http.HttpStatusCode
+import io.ktor.server.application.install
+import io.ktor.server.routing.Routing
+import io.ktor.server.routing.route
+
+fun Routing.reqRespExamples() {
+  route(rootPath) {
+    install(NotarizedRoute()) {
+      post = PostInfo.builder {
+        summary(defaultPathSummary)
+        description(defaultPathDescription)
+        request {
+          description(defaultRequestDescription)
+          requestType<TestRequest>()
+          examples(
+            "Testerina" to TestRequest(TestNested("asdf"), 1.5, emptyList())
+          )
+        }
+        response {
+          description(defaultResponseDescription)
+          responseCode(HttpStatusCode.OK)
+          responseType<TestResponse>()
+          examples(
+            "Testerino" to TestResponse("Heya")
+          )
+        }
+      }
+    }
+  }
+}
+
+fun Routing.exampleParams() = basicGetGenerator<TestResponse>(
+  params = listOf(
+    Parameter(
+      name = "id",
+      `in` = Parameter.Location.path,
+      schema = TypeDefinition.STRING,
+      examples = mapOf(
+        "foo" to Parameter.Example("testing")
+      )
+    )
+  )
+)

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,66 @@
+package io.bkbn.kompendium.core.util
+
+import io.bkbn.kompendium.core.metadata.GetInfo
+import io.bkbn.kompendium.core.plugin.NotarizedRoute
+import io.bkbn.kompendium.core.util.TestModules.defaultPathDescription
+import io.bkbn.kompendium.core.util.TestModules.defaultPathSummary
+import io.bkbn.kompendium.core.util.TestModules.defaultResponseDescription
+import io.bkbn.kompendium.core.util.TestModules.rootPath
+import io.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
+
+object TestModules {
+
+  const val defaultPath = "/test/{a}"
+  const val rootPath = "/"
+  const val defaultResponseDescription = "A Successful Endeavor"
+  const val defaultRequestDescription = "You gotta send it"
+  const val defaultPathSummary = "Great Summary!"
+  const val defaultPathDescription = "testing more"
+
+  val defaultParams = listOf(
+    Parameter(
+      name = "a",
+      `in` = Parameter.Location.path,
+      schema = TypeDefinition.STRING,
+    ),
+    Parameter(
+      name = "aa",
+      `in` = Parameter.Location.query,
+      schema = TypeDefinition.INT
+    )
+  )
+}
+
+internal inline fun <reified T> Routing.basicGetGenerator(
+  params: List<Parameter> = emptyList(),
+  operationId: String? = null
+) {
+  route(rootPath) {
+    basicGetGenerator<T>(params, operationId)
+  }
+}
+
+internal inline fun <reified T> Route.basicGetGenerator(
+  params: List<Parameter> = emptyList(),
+  operationId: String? = null
+) {
+  install(NotarizedRoute()) {
+    get = GetInfo.builder {
+      summary(defaultPathSummary)
+      description(defaultPathDescription)
+      operationId?.let { operationId(it) }
+      parameters = params
+      response {
+        description(defaultResponseDescription)
+        responseCode(HttpStatusCode.OK)
+        responseType<T>()
+      }
+    }
+  }
+}

core/src/test/resources/T0001__notarized_get.json

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

core/src/test/resources/T0002__notarized_post.json

@@ -0,0 +1,124 @@
+{
+  "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}": {
+      "post": {
+        "tags": [],
+        "summary": "Great Summary!",
+        "description": "testing more",
+        "parameters": [],
+        "requestBody": {
+          "description": "A Test request",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/TestSimpleRequest"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "201": {
+            "description": "A Successful Endeavor",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TestCreatedResponse"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "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": {
+        "type": "object",
+        "properties": {
+          "a": {
+            "type": "string"
+          },
+          "b": {
+            "type": "number",
+            "format": "int32"
+          }
+        },
+        "required": [
+          "a",
+          "b"
+        ]
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0003__notarized_put.json

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

core/src/test/resources/T0004__notarized_delete.json

@@ -0,0 +1,73 @@
+{
+  "openapi": "3.1.0",
+  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
+  "info": {
+    "title": "Test API",
+    "version": "1.33.7",
+    "description": "An amazing, fully-ish 😉 generated API spec",
+    "termsOfService": "https://example.com",
+    "contact": {
+      "name": "Homer Simpson",
+      "url": "https://gph.is/1NPUDiM",
+      "email": "chunkylover53@aol.com"
+    },
+    "license": {
+      "name": "MIT",
+      "url": "https://github.com/bkbnio/kompendium/blob/main/LICENSE"
+    }
+  },
+  "servers": [
+    {
+      "url": "https://myawesomeapi.com",
+      "description": "Production instance of my API"
+    },
+    {
+      "url": "https://staging.myawesomeapi.com",
+      "description": "Where the fun stuff happens"
+    }
+  ],
+  "paths": {
+    "/test/{a}": {
+      "delete": {
+        "tags": [],
+        "summary": "Great Summary!",
+        "description": "testing more",
+        "parameters": [],
+        "responses": {
+          "204": {
+            "description": "A Successful Endeavor"
+          }
+        },
+        "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": {},
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0005__notarized_patch.json

@@ -0,0 +1,124 @@
+{
+  "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}": {
+      "patch": {
+        "tags": [],
+        "summary": "Great Summary!",
+        "description": "testing more",
+        "parameters": [],
+        "requestBody": {
+          "description": "A Test request",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/TestSimpleRequest"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "201": {
+            "description": "A Successful Endeavor",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TestCreatedResponse"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "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": {
+        "type": "object",
+        "properties": {
+          "a": {
+            "type": "string"
+          },
+          "b": {
+            "type": "number",
+            "format": "int32"
+          }
+        },
+        "required": [
+          "a",
+          "b"
+        ]
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0006__notarized_head.json

@@ -1,5 +1,6 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.1.0",
+  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
   "info": {
     "title": "Test API",
     "version": "1.33.7",
@@ -26,21 +27,43 @@
     }
   ],
   "paths": {
-    "/test": {
+    "/test/{a}": {
       "head": {
         "tags": [],
-        "summary": "Test head endpoint",
+        "summary": "Great Summary!",
-        "description": "head test 💀",
+        "description": "testing more",
         "parameters": [],
         "responses": {
-          "200": {
+          "201": {
             "description": "great!"
           }
         },
         "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": {},
     "securitySchemes": {}

core/src/test/resources/T0007__notarized_options.json

@@ -1,5 +1,6 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.1.0",
+  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
   "info": {
     "title": "Test API",
     "version": "1.33.7",
@@ -26,58 +27,64 @@
     }
   ],
   "paths": {
-    "/test": {
+    "/test/{a}": {
       "options": {
         "tags": [],
-        "summary": "Test options",
+        "summary": "Great Summary!",
-        "description": "endpoint of options",
+        "description": "testing more",
-        "parameters": [
+        "parameters": [],
-          {
-            "name": "a",
-            "in": "path",
-            "schema": {
-              "type": "string"
-            },
-            "required": true,
-            "deprecated": false
-          },
-          {
-            "name": "aa",
-            "in": "query",
-            "schema": {
-              "format": "int32",
-              "type": "integer"
-            },
-            "required": true,
-            "deprecated": false
-          }
-        ],
         "responses": {
           "200": {
             "description": "nice",
             "content": {
               "application/json": {
                 "schema": {
-                  "properties": {
+                  "$ref": "#/components/schemas/TestResponse"
-                    "c": {
-                      "type": "string"
-                    }
-                  },
-                  "required": [
-                    "c"
-                  ],
-                  "type": "object"
                 }
               }
             }
           }
         },
         "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": {},
+    "schemas": {
+      "TestResponse": {
+        "type": "object",
+        "properties": {
+          "c": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "c"
+        ]
+      }
+    },
     "securitySchemes": {}
   },
   "security": [],

core/src/test/resources/T0008__complex_type.json

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

core/src/test/resources/T0009__notarized_primitives.json

@@ -1,5 +1,6 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.1.0",
+  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
   "info": {
     "title": "Test API",
     "version": "1.33.7",
@@ -26,19 +27,18 @@
     }
   ],
   "paths": {
-    "/test": {
+    "/": {
       "put": {
         "tags": [],
-        "summary": "Test put endpoint",
+        "summary": "Great Summary!",
-        "description": "Put your tests here!",
+        "description": "testing more",
         "parameters": [],
         "requestBody": {
-          "description": "A Test request",
+          "description": "A Test Request",
           "content": {
             "application/json": {
               "schema": {
-                "format": "int32",
+                "$ref": "#/components/schemas/Int"
-                "type": "integer"
               }
             }
           },
@@ -50,18 +50,28 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "type": "boolean"
+                  "$ref": "#/components/schemas/Boolean"
                 }
               }
             }
           }
         },
         "deprecated": false
-      }
+      },
+      "parameters": []
     }
   },
+  "webhooks": {},
   "components": {
-    "schemas": {},
+    "schemas": {
+      "Boolean": {
+        "type": "boolean"
+      },
+      "Int": {
+        "type": "number",
+        "format": "int32"
+      }
+    },
     "securitySchemes": {}
   },
   "security": [],

core/src/test/resources/T0010__response_list.json

@@ -1,5 +1,6 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.1.0",
+  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
   "info": {
     "title": "Test API",
     "version": "1.33.7",
@@ -26,61 +27,70 @@
     }
   ],
   "paths": {
-    "/test": {
+    "/test/{a}": {
       "get": {
         "tags": [],
-        "summary": "Another get test",
+        "summary": "Great Summary!",
         "description": "testing more",
-        "parameters": [
+        "parameters": [],
-          {
-            "name": "a",
-            "in": "path",
-            "schema": {
-              "type": "string"
-            },
-            "required": true,
-            "deprecated": false
-          },
-          {
-            "name": "aa",
-            "in": "query",
-            "schema": {
-              "format": "int32",
-              "type": "integer"
-            },
-            "required": true,
-            "deprecated": false
-          }
-        ],
         "responses": {
           "200": {
             "description": "A Successful List-y Endeavor",
             "content": {
               "application/json": {
                 "schema": {
-                  "items": {
+                  "$ref": "#/components/schemas/List-TestResponse"
-                    "properties": {
-                      "c": {
-                        "type": "string"
-                      }
-                    },
-                    "required": [
-                      "c"
-                    ],
-                    "type": "object"
-                  },
-                  "type": "array"
                 }
               }
             }
           }
         },
         "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": {},
+    "schemas": {
+      "TestResponse": {
+        "type": "object",
+        "properties": {
+          "c": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "c"
+        ]
+      },
+      "List-TestResponse": {
+        "items": {
+          "$ref": "#/components/schemas/TestResponse"
+        },
+        "type": "array"
+      }
+    },
     "securitySchemes": {}
   },
   "security": [],

core/src/test/resources/T0011__non_required_params.json

@@ -1,5 +1,6 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.1.0",
+  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
   "info": {
     "title": "Test API",
     "version": "1.33.7",
@@ -26,41 +27,42 @@
     }
   ],
   "paths": {
-    "/test/optional": {
+    "/optional": {
       "get": {
         "tags": [],
-        "summary": "No request params and response body",
+        "summary": "Great Summary!",
         "description": "testing more",
-        "parameters": [
+        "parameters": [],
-          {
-            "name": "notRequired",
-            "in": "query",
-            "schema": {
-              "type": "string",
-              "nullable": true
-            },
-            "required": false,
-            "deprecated": false
-          },
-          {
-            "name": "required",
-            "in": "query",
-            "schema": {
-              "type": "string"
-            },
-            "required": true,
-            "deprecated": false
-          }
-        ],
         "responses": {
           "204": {
             "description": "Empty"
           }
         },
         "deprecated": false
-      }
+      },
+      "parameters": [
+        {
+          "name": "notRequired",
+          "in": "query",
+          "schema": {
+            "type": "string"
+          },
+          "required": false,
+          "deprecated": false
+        },
+        {
+          "name": "required",
+          "in": "query",
+          "schema": {
+            "type": "string"
+          },
+          "required": true,
+          "deprecated": false
+        }
+      ]
     }
   },
+  "webhooks": {},
   "components": {
     "schemas": {},
     "securitySchemes": {}

core/src/test/resources/T0012__path_parser.json

@@ -1,5 +1,6 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.1.0",
+  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
   "info": {
     "title": "Test API",
     "version": "1.33.7",
@@ -29,27 +30,17 @@
     "/this/is/a/complex/path/with/an/{id}": {
       "get": {
         "tags": [],
-        "summary": "Another get test",
+        "summary": "Great Summary!",
         "description": "testing more",
         "parameters": [
           {
-            "name": "a",
+            "name": "id",
             "in": "path",
             "schema": {
               "type": "string"
             },
             "required": true,
             "deprecated": false
-          },
-          {
-            "name": "aa",
-            "in": "query",
-            "schema": {
-              "format": "int32",
-              "type": "integer"
-            },
-            "required": true,
-            "deprecated": false
           }
         ],
         "responses": {
@@ -58,26 +49,32 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "properties": {
+                  "$ref": "#/components/schemas/TestResponse"
-                    "c": {
-                      "type": "string"
-                    }
-                  },
-                  "required": [
-                    "c"
-                  ],
-                  "type": "object"
                 }
               }
             }
           }
         },
         "deprecated": false
-      }
+      },
+      "parameters": []
     }
   },
+  "webhooks": {},
   "components": {
-    "schemas": {},
+    "schemas": {
+      "TestResponse": {
+        "type": "object",
+        "properties": {
+          "c": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "c"
+        ]
+      }
+    },
     "securitySchemes": {}
   },
   "security": [],

core/src/test/resources/T0013__root_route.json

@@ -0,0 +1,83 @@
+{
+  "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
+      },
+      "parameters": [
+        {
+          "name": "aa",
+          "in": "query",
+          "schema": {
+            "type": "number",
+            "format": "int32"
+          },
+          "required": true,
+          "deprecated": false
+        }
+      ]
+    }
+  },
+  "webhooks": {},
+  "components": {
+    "schemas": {
+      "TestResponse": {
+        "type": "object",
+        "properties": {
+          "c": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "c"
+        ]
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0014__nested_under_root.json

@@ -1,5 +1,6 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.1.0",
+  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
   "info": {
     "title": "Test API",
     "version": "1.33.7",
@@ -26,40 +27,44 @@
     }
   ],
   "paths": {
-    "/test/required_param": {
+    "/testerino": {
       "get": {
         "tags": [],
-        "summary": "required param",
+        "summary": "Great Summary!",
-        "description": "Cool stuff",
+        "description": "testing more",
         "parameters": [],
         "responses": {
           "200": {
-            "description": "A successful endeavor",
+            "description": "A Successful Endeavor",
             "content": {
               "application/json": {
                 "schema": {
-                  "properties": {
+                  "$ref": "#/components/schemas/TestResponse"
-                    "a": {
-                      "type": "string",
-                      "minLength": 42,
-                      "maxLength": 1337
-                    }
-                  },
-                  "required": [
-                    "a"
-                  ],
-                  "type": "object"
                 }
               }
             }
           }
         },
         "deprecated": false
-      }
+      },
+      "parameters": []
     }
   },
+  "webhooks": {},
   "components": {
-    "schemas": {},
+    "schemas": {
+      "TestResponse": {
+        "type": "object",
+        "properties": {
+          "c": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "c"
+        ]
+      }
+    },
     "securitySchemes": {}
   },
   "security": [],

core/src/test/resources/T0015__trailing_slash.json

@@ -1,5 +1,6 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.1.0",
+  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
   "info": {
     "title": "Test API",
     "version": "1.33.7",
@@ -26,40 +27,44 @@
     }
   ],
   "paths": {
-    "/test/required_param": {
+    "/test/": {
       "get": {
         "tags": [],
-        "summary": "required param",
+        "summary": "Great Summary!",
-        "description": "Cool stuff",
+        "description": "testing more",
         "parameters": [],
         "responses": {
           "200": {
-            "description": "A successful endeavor",
+            "description": "A Successful Endeavor",
             "content": {
               "application/json": {
                 "schema": {
-                  "properties": {
+                  "$ref": "#/components/schemas/TestResponse"
-                    "a": {
-                      "format": "double",
-                      "type": "number",
-                      "multipleOf": 2.5
-                    }
-                  },
-                  "required": [
-                    "a"
-                  ],
-                  "type": "object"
                 }
               }
             }
           }
         },
         "deprecated": false
-      }
+      },
+      "parameters": []
     }
   },
+  "webhooks": {},
   "components": {
-    "schemas": {},
+    "schemas": {
+      "TestResponse": {
+        "type": "object",
+        "properties": {
+          "c": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "c"
+        ]
+      }
+    },
     "securitySchemes": {}
   },
   "security": [],

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

core/src/test/resources/T0017__notarized_get_with_multiple_exception_responses.json

@@ -1,5 +1,6 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.1.0",
+  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
   "info": {
     "title": "Test API",
     "version": "1.33.7",
@@ -26,47 +27,19 @@
     }
   ],
   "paths": {
-    "/test": {
+    "/": {
       "get": {
         "tags": [],
-        "summary": "Another get test",
+        "summary": "Great Summary!",
         "description": "testing more",
-        "parameters": [
+        "parameters": [],
-          {
-            "name": "a",
-            "in": "path",
-            "schema": {
-              "type": "string"
-            },
-            "required": true,
-            "deprecated": false
-          },
-          {
-            "name": "aa",
-            "in": "query",
-            "schema": {
-              "format": "int32",
-              "type": "integer"
-            },
-            "required": true,
-            "deprecated": false
-          }
-        ],
         "responses": {
           "200": {
             "description": "A Successful Endeavor",
             "content": {
               "application/json": {
                 "schema": {
-                  "properties": {
+                  "$ref": "#/components/schemas/TestResponse"
-                    "c": {
-                      "type": "string"
-                    }
-                  },
-                  "required": [
-                    "c"
-                  ],
-                  "type": "object"
                 }
               }
             }
@@ -76,26 +49,53 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "properties": {
+                  "$ref": "#/components/schemas/ExceptionResponse"
-                    "message": {
+                }
-                      "type": "string"
+              }
-                    }
+            }
-                  },
+          },
-                  "required": [
+          "403": {
-                    "message"
+            "description": "Access Denied",
-                  ],
+            "content": {
-                  "type": "object"
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ExceptionResponse"
                 }
               }
             }
           }
         },
         "deprecated": false
-      }
+      },
+      "parameters": []
     }
   },
+  "webhooks": {},
   "components": {
-    "schemas": {},
+    "schemas": {
+      "TestResponse": {
+        "type": "object",
+        "properties": {
+          "c": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "c"
+        ]
+      },
+      "ExceptionResponse": {
+        "type": "object",
+        "properties": {
+          "message": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "message"
+        ]
+      }
+    },
     "securitySchemes": {}
   },
   "security": [],

core/src/test/resources/T0018__polymorphic_error_status_codes.json

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

core/src/test/resources/T0019__generic_exception.json

@@ -0,0 +1,118 @@
+{
+  "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"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Bad Things Happened",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Flibbity-String"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "parameters": []
+    }
+  },
+  "webhooks": {},
+  "components": {
+    "schemas": {
+      "TestResponse": {
+        "type": "object",
+        "properties": {
+          "c": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "c"
+        ]
+      },
+      "Bibbity-String": {
+        "type": "object",
+        "properties": {
+          "b": {
+            "type": "string"
+          },
+          "f": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "b",
+          "f"
+        ]
+      },
+      "Gibbity-String": {
+        "type": "object",
+        "properties": {
+          "a": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "a"
+        ]
+      },
+      "Flibbity-String": {
+        "anyOf": [
+          {
+            "$ref": "#/components/schemas/Bibbity-String"
+          },
+          {
+            "$ref": "#/components/schemas/Gibbity-String"
+          }
+        ]
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0020__example_req_and_resp.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": true
+        },
+        "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/T0021__example_parameters.json

@@ -1,5 +1,6 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.1.0",
+  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
   "info": {
     "title": "Test API",
     "version": "1.33.7",
@@ -26,30 +27,25 @@
     }
   ],
   "paths": {
-    "/testerino": {
+    "/": {
       "get": {
         "tags": [],
-        "summary": "Another get test",
+        "summary": "Great Summary!",
         "description": "testing more",
         "parameters": [
           {
-            "name": "a",
+            "name": "id",
             "in": "path",
             "schema": {
               "type": "string"
             },
             "required": true,
-            "deprecated": false
+            "deprecated": false,
-          },
+            "examples": {
-          {
+              "foo": {
-            "name": "aa",
+                "value": "testing"
-            "in": "query",
+              }
-            "schema": {
+            }
-              "format": "int32",
-              "type": "integer"
-            },
-            "required": true,
-            "deprecated": false
           }
         ],
         "responses": {
@@ -58,26 +54,32 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "properties": {
+                  "$ref": "#/components/schemas/TestResponse"
-                    "c": {
-                      "type": "string"
-                    }
-                  },
-                  "required": [
-                    "c"
-                  ],
-                  "type": "object"
                 }
               }
             }
           }
         },
         "deprecated": false
-      }
+      },
+      "parameters": []
     }
   },
+  "webhooks": {},
   "components": {
-    "schemas": {},
+    "schemas": {
+      "TestResponse": {
+        "type": "object",
+        "properties": {
+          "c": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "c"
+        ]
+      }
+    },
     "securitySchemes": {}
   },
   "security": [],

core/src/test/resources/T0022__query_with_default_parameter.json

@@ -1,5 +1,6 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.1.0",
+  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
   "info": {
     "title": "Test API",
     "version": "1.33.7",
@@ -26,27 +27,18 @@
     }
   ],
   "paths": {
-    "/test/": {
+    "/": {
       "get": {
         "tags": [],
-        "summary": "Another get test",
+        "summary": "Great Summary!",
         "description": "testing more",
         "parameters": [
           {
-            "name": "a",
+            "name": "id",
             "in": "path",
             "schema": {
-              "type": "string"
+              "type": "string",
-            },
+              "default": "IDK"
-            "required": true,
-            "deprecated": false
-          },
-          {
-            "name": "aa",
-            "in": "query",
-            "schema": {
-              "format": "int32",
-              "type": "integer"
             },
             "required": true,
             "deprecated": false
@@ -58,26 +50,32 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "properties": {
+                  "$ref": "#/components/schemas/TestResponse"
-                    "c": {
-                      "type": "string"
-                    }
-                  },
-                  "required": [
-                    "c"
-                  ],
-                  "type": "object"
                 }
               }
             }
           }
         },
         "deprecated": false
-      }
+      },
+      "parameters": []
     }
   },
+  "webhooks": {},
   "components": {
-    "schemas": {},
+    "schemas": {
+      "TestResponse": {
+        "type": "object",
+        "properties": {
+          "c": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "c"
+        ]
+      }
+    },
     "securitySchemes": {}
   },
   "security": [],

core/src/test/resources/T0023__required_param.json

@@ -1,5 +1,6 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.1.0",
+  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
   "info": {
     "title": "Test API",
     "version": "1.33.7",
@@ -29,27 +30,17 @@
     "/": {
       "get": {
         "tags": [],
-        "summary": "Another get test",
+        "summary": "Great Summary!",
         "description": "testing more",
         "parameters": [
           {
-            "name": "a",
+            "name": "id",
             "in": "path",
             "schema": {
               "type": "string"
             },
             "required": true,
             "deprecated": false
-          },
-          {
-            "name": "aa",
-            "in": "query",
-            "schema": {
-              "format": "int32",
-              "type": "integer"
-            },
-            "required": true,
-            "deprecated": false
           }
         ],
         "responses": {
@@ -58,26 +49,32 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "properties": {
+                  "$ref": "#/components/schemas/TestResponse"
-                    "c": {
-                      "type": "string"
-                    }
-                  },
-                  "required": [
-                    "c"
-                  ],
-                  "type": "object"
                 }
               }
             }
           }
         },
         "deprecated": false
-      }
+      },
+      "parameters": []
     }
   },
+  "webhooks": {},
   "components": {
-    "schemas": {},
+    "schemas": {
+      "TestResponse": {
+        "type": "object",
+        "properties": {
+          "c": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "c"
+        ]
+      }
+    },
     "securitySchemes": {}
   },
   "security": [],

core/src/test/resources/T0024__non_required_param.json

@@ -1,5 +1,6 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.1.0",
+  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
   "info": {
     "title": "Test API",
     "version": "1.33.7",
@@ -26,29 +27,19 @@
     }
   ],
   "paths": {
-    "/test": {
+    "/": {
       "get": {
         "tags": [],
-        "summary": "Another get test",
+        "summary": "Great Summary!",
         "description": "testing more",
         "parameters": [
           {
-            "name": "a",
+            "name": "id",
-            "in": "path",
+            "in": "query",
             "schema": {
               "type": "string"
             },
-            "required": true,
+            "required": false,
-            "deprecated": false
-          },
-          {
-            "name": "aa",
-            "in": "query",
-            "schema": {
-              "format": "int32",
-              "type": "integer"
-            },
-            "required": true,
             "deprecated": false
           }
         ],
@@ -58,26 +49,32 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "properties": {
+                  "$ref": "#/components/schemas/TestResponse"
-                    "c": {
-                      "type": "string"
-                    }
-                  },
-                  "required": [
-                    "c"
-                  ],
-                  "type": "object"
                 }
               }
             }
           }
         },
         "deprecated": false
-      }
+      },
+      "parameters": []
     }
   },
+  "webhooks": {},
   "components": {
-    "schemas": {},
+    "schemas": {
+      "TestResponse": {
+        "type": "object",
+        "properties": {
+          "c": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "c"
+        ]
+      }
+    },
     "securitySchemes": {}
   },
   "security": [],

core/src/test/resources/T0025__default_field.json

@@ -1,5 +1,6 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.1.0",
+  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
   "info": {
     "title": "Test API",
     "version": "1.33.7",
@@ -26,43 +27,48 @@
     }
   ],
   "paths": {
-    "/test/polymorphic": {
+    "/": {
       "get": {
         "tags": [],
-        "summary": "Single Generic",
+        "summary": "Great Summary!",
-        "description": "Simple generic data class",
+        "description": "testing more",
         "parameters": [],
         "responses": {
           "200": {
-            "description": "A successful endeavor",
+            "description": "A Successful Endeavor",
             "content": {
               "application/json": {
                 "schema": {
-                  "properties": {
+                  "$ref": "#/components/schemas/DefaultField"
-                    "messy": {
-                      "type": "string"
-                    },
-                    "potato": {
-                      "format": "int32",
-                      "type": "integer"
-                    }
-                  },
-                  "required": [
-                    "messy",
-                    "potato"
-                  ],
-                  "type": "object"
                 }
               }
             }
           }
         },
         "deprecated": false
-      }
+      },
+      "parameters": []
     }
   },
+  "webhooks": {},
   "components": {
-    "schemas": {},
+    "schemas": {
+      "DefaultField": {
+        "type": "object",
+        "properties": {
+          "a": {
+            "type": "string"
+          },
+          "b": {
+            "type": "number",
+            "format": "int32"
+          }
+        },
+        "required": [
+          "b"
+        ]
+      }
+    },
     "securitySchemes": {}
   },
   "security": [],

core/src/test/resources/T0026__nullable_field.json

@@ -1,5 +1,6 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.1.0",
+  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
   "info": {
     "title": "Test API",
     "version": "1.33.7",
@@ -26,39 +27,49 @@
     }
   ],
   "paths": {
-    "/test/required_param": {
+    "/": {
       "get": {
         "tags": [],
-        "summary": "required param",
+        "summary": "Great Summary!",
-        "description": "Cool stuff",
+        "description": "testing more",
         "parameters": [],
         "responses": {
           "200": {
-            "description": "A successful endeavor",
+            "description": "A Successful Endeavor",
             "content": {
               "application/json": {
                 "schema": {
-                  "properties": {
+                  "$ref": "#/components/schemas/NullableField"
-                    "data": {
-                      "additionalProperties": true,
-                      "type": "object"
-                    }
-                  },
-                  "required": [
-                    "data"
-                  ],
-                  "type": "object"
                 }
               }
             }
           }
         },
         "deprecated": false
-      }
+      },
+      "parameters": []
     }
   },
+  "webhooks": {},
   "components": {
-    "schemas": {},
+    "schemas": {
+      "NullableField": {
+        "type": "object",
+        "properties": {
+          "a": {
+            "oneOf": [
+              {
+                "type": "null"
+              },
+              {
+                "type": "string"
+              }
+            ]
+          }
+        },
+        "required": []
+      }
+    },
     "securitySchemes": {}
   },
   "security": [],

core/src/test/resources/T0027__polymorphic_response.json

@@ -0,0 +1,105 @@
+{
+  "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/FlibbityGibbit"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "parameters": []
+    }
+  },
+  "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"
+        ]
+      },
+      "FlibbityGibbit": {
+        "anyOf": [
+          {
+            "$ref": "#/components/schemas/ComplexGibbit"
+          },
+          {
+            "$ref": "#/components/schemas/SimpleGibbit"
+          }
+        ]
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0028__polymorphic_list_response.json

@@ -0,0 +1,108 @@
+{
+  "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/List-FlibbityGibbit"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "parameters": []
+    }
+  },
+  "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"
+        ]
+      },
+      "List-FlibbityGibbit": {
+        "items": {
+          "anyOf": [
+            {
+              "$ref": "#/components/schemas/ComplexGibbit"
+            },
+            {
+              "$ref": "#/components/schemas/SimpleGibbit"
+            }
+          ]
+        },
+        "type": "array"
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0029__polymorphic_map_response.json

@@ -0,0 +1,108 @@
+{
+  "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/Map-String-FlibbityGibbit"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "parameters": []
+    }
+  },
+  "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"
+        ]
+      },
+      "Map-String-FlibbityGibbit": {
+        "additionalProperties": {
+          "anyOf": [
+            {
+              "$ref": "#/components/schemas/ComplexGibbit"
+            },
+            {
+              "$ref": "#/components/schemas/SimpleGibbit"
+            }
+          ]
+        },
+        "type": "object"
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0030__simple_generic_response.json

@@ -1,5 +1,6 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.1.0",
+  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
   "info": {
     "title": "Test API",
     "version": "1.33.7",
@@ -26,38 +27,44 @@
     }
   ],
   "paths": {
-    "/test": {
+    "/": {
-      "patch": {
+      "get": {
         "tags": [],
-        "summary": "Test patch endpoint",
+        "summary": "Great Summary!",
-        "description": "patch your tests here!",
+        "description": "testing more",
         "parameters": [],
         "responses": {
-          "201": {
+          "200": {
             "description": "A Successful Endeavor",
             "content": {
               "application/json": {
                 "schema": {
-                  "properties": {
+                  "$ref": "#/components/schemas/Gibbity-String"
-                    "c": {
-                      "type": "string"
-                    }
-                  },
-                  "required": [
-                    "c"
-                  ],
-                  "type": "object"
                 }
               }
             }
           }
         },
         "deprecated": false
-      }
+      },
+      "parameters": []
     }
   },
+  "webhooks": {},
   "components": {
-    "schemas": {},
+    "schemas": {
+      "Gibbity-String": {
+        "type": "object",
+        "properties": {
+          "a": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "a"
+        ]
+      }
+    },
     "securitySchemes": {}
   },
   "security": [],

core/src/test/resources/T0031__nested_generic_response.json

@@ -1,5 +1,6 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.1.0",
+  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
   "info": {
     "title": "Test API",
     "version": "1.33.7",
@@ -26,48 +27,47 @@
     }
   ],
   "paths": {
-    "/test/required_param": {
+    "/": {
       "get": {
         "tags": [],
-        "summary": "required param",
+        "summary": "Great Summary!",
-        "description": "Cool stuff",
+        "description": "testing more",
-        "parameters": [
+        "parameters": [],
-          {
-            "name": "a",
-            "in": "query",
-            "schema": {
-              "type": "string"
-            },
-            "required": true,
-            "deprecated": false
-          }
-        ],
         "responses": {
           "200": {
-            "description": "A successful endeavor",
+            "description": "A Successful Endeavor",
             "content": {
               "application/json": {
                 "schema": {
-                  "properties": {
+                  "$ref": "#/components/schemas/Gibbity-Map"
-                    "c": {
-                      "type": "string"
-                    }
-                  },
-                  "required": [
-                    "c"
-                  ],
-                  "type": "object"
                 }
               }
             }
           }
         },
         "deprecated": false
-      }
+      },
+      "parameters": []
     }
   },
+  "webhooks": {},
   "components": {
-    "schemas": {},
+    "schemas": {
+      "Gibbity-Map": {
+        "type": "object",
+        "properties": {
+          "a": {
+            "additionalProperties": {
+              "type": "string"
+            },
+            "type": "object"
+          }
+        },
+        "required": [
+          "a"
+        ]
+      }
+    },
     "securitySchemes": {}
   },
   "security": [],

core/src/test/resources/T0032__polymorphic_response_with_generics.json

@@ -0,0 +1,99 @@
+{
+  "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/Flibbity-Double"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "parameters": []
+    }
+  },
+  "webhooks": {},
+  "components": {
+    "schemas": {
+      "Bibbity-Double": {
+        "type": "object",
+        "properties": {
+          "b": {
+            "type": "string"
+          },
+          "f": {
+            "type": "number",
+            "format": "double"
+          }
+        },
+        "required": [
+          "b",
+          "f"
+        ]
+      },
+      "Gibbity-Double": {
+        "type": "object",
+        "properties": {
+          "a": {
+            "type": "number",
+            "format": "double"
+          }
+        },
+        "required": [
+          "a"
+        ]
+      },
+      "Flibbity-Double": {
+        "anyOf": [
+          {
+            "$ref": "#/components/schemas/Bibbity-Double"
+          },
+          {
+            "$ref": "#/components/schemas/Gibbity-Double"
+          }
+        ]
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0033__crazy_polymorphic_example.json

@@ -0,0 +1,145 @@
+{
+  "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/Flibbity-FlibbityGibbit"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "parameters": []
+    }
+  },
+  "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": {
+          "b": {
+            "type": "string"
+          },
+          "f": {
+            "anyOf": [
+              {
+                "$ref": "#/components/schemas/ComplexGibbit"
+              },
+              {
+                "$ref": "#/components/schemas/SimpleGibbit"
+              }
+            ]
+          }
+        },
+        "required": [
+          "b",
+          "f"
+        ]
+      },
+      "Gibbity-FlibbityGibbit": {
+        "type": "object",
+        "properties": {
+          "a": {
+            "anyOf": [
+              {
+                "$ref": "#/components/schemas/ComplexGibbit"
+              },
+              {
+                "$ref": "#/components/schemas/SimpleGibbit"
+              }
+            ]
+          }
+        },
+        "required": [
+          "a"
+        ]
+      },
+      "Flibbity-FlibbityGibbit": {
+        "anyOf": [
+          {
+            "$ref": "#/components/schemas/Bibbity-FlibbityGibbit"
+          },
+          {
+            "$ref": "#/components/schemas/Gibbity-FlibbityGibbit"
+          }
+        ]
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0034__notarized_get_with_operation_id.json

@@ -1,5 +1,6 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.1.0",
+  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
   "info": {
     "title": "Test API",
     "version": "1.33.7",
@@ -26,41 +27,45 @@
     }
   ],
   "paths": {
-    "/test/required_param": {
+    "/": {
       "get": {
         "tags": [],
-        "summary": "required param",
+        "summary": "Great Summary!",
-        "description": "Cool stuff",
+        "description": "testing more",
+        "operationId": "getThisDude",
         "parameters": [],
         "responses": {
           "200": {
-            "description": "A successful endeavor",
+            "description": "A Successful Endeavor",
             "content": {
               "application/json": {
                 "schema": {
-                  "properties": {
+                  "$ref": "#/components/schemas/TestResponse"
-                    "data": {
-                      "minProperties": 5,
-                      "maxProperties": 10,
-                      "additionalProperties": true,
-                      "type": "object"
-                    }
-                  },
-                  "required": [
-                    "data"
-                  ],
-                  "type": "object"
                 }
               }
             }
           }
         },
         "deprecated": false
-      }
+      },
+      "parameters": []
     }
   },
+  "webhooks": {},
   "components": {
-    "schemas": {},
+    "schemas": {
+      "TestResponse": {
+        "type": "object",
+        "properties": {
+          "c": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "c"
+        ]
+      }
+    },
     "securitySchemes": {}
   },
   "security": [],

core/src/test/resources/T0035__override_parameter_name.json

@@ -1,5 +1,6 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.1.0",
+  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
   "info": {
     "title": "Test API",
     "version": "1.33.7",
@@ -26,14 +27,14 @@
     }
   ],
   "paths": {
-    "/test/with_header": {
+    "/": {
       "get": {
         "tags": [],
-        "summary": "testing header stuffs",
+        "summary": "Great Summary!",
-        "description": "Good for many things",
+        "description": "testing more",
         "parameters": [
           {
-            "name": "X-UserEmail",
+            "name": "X-User-Email",
             "in": "header",
             "schema": {
               "type": "string"
@@ -44,30 +45,36 @@
         ],
         "responses": {
           "200": {
-            "description": "A successful endeavor",
+            "description": "A Successful Endeavor",
             "content": {
               "application/json": {
                 "schema": {
-                  "properties": {
+                  "$ref": "#/components/schemas/TestResponse"
-                    "c": {
-                      "type": "string"
-                    }
-                  },
-                  "required": [
-                    "c"
-                  ],
-                  "type": "object"
                 }
               }
             }
           }
         },
         "deprecated": false
-      }
+      },
+      "parameters": []
     }
   },
+  "webhooks": {},
   "components": {
-    "schemas": {},
+    "schemas": {
+      "TestResponse": {
+        "type": "object",
+        "properties": {
+          "c": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "c"
+        ]
+      }
+    },
     "securitySchemes": {}
   },
   "security": [],

core/src/test/resources/T0036__nullable_fields.json

@@ -0,0 +1,124 @@
+{
+  "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/ProfileUpdateRequest"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "parameters": []
+    }
+  },
+  "webhooks": {},
+  "components": {
+    "schemas": {
+      "ProfileUpdateRequest": {
+        "type": "object",
+        "properties": {
+          "metadata": {
+            "oneOf": [
+              {
+                "type": "null"
+              },
+              {
+                "$ref": "#/components/schemas/ProfileMetadataUpdateRequest"
+              }
+            ]
+          },
+          "mood": {
+            "oneOf": [
+              {
+                "type": "null"
+              },
+              {
+                "type": "string"
+              }
+            ]
+          },
+          "viewCount": {
+            "oneOf": [
+              {
+                "type": "null"
+              },
+              {
+                "type": "number",
+                "format": "int64"
+              }
+            ]
+          }
+        },
+        "required": []
+      },
+      "ProfileMetadataUpdateRequest": {
+        "type": "object",
+        "properties": {
+          "isPrivate": {
+            "oneOf": [
+              {
+                "type": "null"
+              },
+              {
+                "type": "boolean"
+              }
+            ]
+          },
+          "otherThing": {
+            "oneOf": [
+              {
+                "type": "null"
+              },
+              {
+                "type": "string"
+              }
+            ]
+          }
+        },
+        "required": []
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0037__nullable_enum_field.json

@@ -0,0 +1,85 @@
+{
+  "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/NullableEnum"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "parameters": []
+    }
+  },
+  "webhooks": {},
+  "components": {
+    "schemas": {
+      "NullableEnum": {
+        "type": "object",
+        "properties": {
+          "a": {
+            "oneOf": [
+              {
+                "type": "null"
+              },
+              {
+                "$ref": "#/components/schemas/TestEnum"
+              }
+            ]
+          }
+        },
+        "required": []
+      },
+      "TestEnum":
+          {
+            "type": "string",
+            "enum": [
+              "YES",
+              "NO"
+            ]
+          }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0038__formatted_date_time_string.json

@@ -1,5 +1,6 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.1.0",
+  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
   "info": {
     "title": "Test API",
     "version": "1.33.7",
@@ -26,43 +27,49 @@
     }
   ],
   "paths": {
-    "/test/required_param": {
+    "/": {
       "get": {
         "tags": [],
-        "summary": "required param",
+        "summary": "Great Summary!",
-        "description": "Cool stuff",
+        "description": "testing more",
         "parameters": [],
         "responses": {
           "200": {
-            "description": "A successful endeavor",
+            "description": "A Successful Endeavor",
             "content": {
               "application/json": {
                 "schema": {
-                  "properties": {
+                  "$ref": "#/components/schemas/DateTimeString"
-                    "a": {
-                      "items": {
-                        "type": "string"
-                      },
-                      "minItems": 1,
-                      "maxItems": 10,
-                      "type": "array"
-                    }
-                  },
-                  "required": [
-                    "a"
-                  ],
-                  "type": "object"
                 }
               }
             }
           }
         },
         "deprecated": false
-      }
+      },
+      "parameters": []
     }
   },
+  "webhooks": {},
   "components": {
-    "schemas": {},
+    "schemas": {
+      "Instant": {
+        "type": "string",
+        "format": "date"
+      },
+      "DateTimeString": {
+        "type": "object",
+        "properties": {
+          "a": {
+            "type": "string",
+            "format": "date"
+          }
+        },
+        "required": [
+          "a"
+        ]
+      }
+    },
     "securitySchemes": {}
   },
   "security": [],

core/src/test/resources/T0039__nested_generic_collection.json

@@ -0,0 +1,101 @@
+{
+  "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/Page-Int"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "parameters": []
+    }
+  },
+  "webhooks": {},
+  "components": {
+    "schemas": {
+      "Page-Int": {
+        "type": "object",
+        "properties": {
+          "content": {
+            "items": {
+              "type": "number",
+              "format": "int32"
+            },
+            "type": "array"
+          },
+          "number": {
+            "type": "number",
+            "format": "int32"
+          },
+          "numberOfElements": {
+            "type": "number",
+            "format": "int32"
+          },
+          "size": {
+            "type": "number",
+            "format": "int32"
+          },
+          "totalElements": {
+            "type": "number",
+            "format": "int64"
+          },
+          "totalPages": {
+            "type": "number",
+            "format": "int32"
+          }
+        },
+        "required": [
+          "content",
+          "number",
+          "numberOfElements",
+          "size",
+          "totalElements",
+          "totalPages"
+        ]
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0040__nested_generic_multiple_type_params.json

@@ -0,0 +1,133 @@
+{
+  "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/MultiNestedGenerics-String-ComplexRequest"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "parameters": []
+    }
+  },
+  "webhooks": {},
+  "components": {
+    "schemas": {
+      "CrazyItem": {
+        "type": "object",
+        "properties": {
+          "enumeration": {
+            "$ref": "#/components/schemas/SimpleEnum"
+          }
+        },
+        "required": [
+          "enumeration"
+        ]
+      },
+      "NestedComplexItem": {
+        "type": "object",
+        "properties": {
+          "alias": {
+            "additionalProperties": {
+              "$ref": "#/components/schemas/CrazyItem"
+            },
+            "type": "object"
+          },
+          "name": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "alias",
+          "name"
+        ]
+      },
+      "ComplexRequest": {
+        "type": "object",
+        "properties": {
+          "amazingField": {
+            "type": "string"
+          },
+          "org": {
+            "type": "string"
+          },
+          "tables": {
+            "items": {
+              "$ref": "#/components/schemas/NestedComplexItem"
+            },
+            "type": "array"
+          }
+        },
+        "required": [
+          "amazingField",
+          "org",
+          "tables"
+        ]
+      },
+      "MultiNestedGenerics-String-ComplexRequest": {
+        "type": "object",
+        "properties": {
+          "content": {
+            "additionalProperties": {
+              "$ref": "#/components/schemas/ComplexRequest"
+            },
+            "type": "object"
+          }
+        },
+        "required": [
+          "content"
+        ]
+      },
+      "SimpleEnum": {
+        "type": "string",
+        "enum": [
+          "ONE",
+          "TWO"
+        ]
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0041__nullable_reference.json

@@ -0,0 +1,98 @@
+{
+  "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/ManyThings"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "parameters": []
+    }
+  },
+  "webhooks": {},
+  "components": {
+    "schemas": {
+      "Something": {
+        "type": "object",
+        "properties": {
+          "a": {
+            "type": "string"
+          },
+          "b": {
+            "type": "number",
+            "format": "int32"
+          }
+        },
+        "required": [
+          "a",
+          "b"
+        ]
+      },
+      "ManyThings": {
+        "type": "object",
+        "properties": {
+          "someA": {
+            "$ref": "#/components/schemas/Something"
+          },
+          "someB": {
+            "oneOf": [
+              {
+                "type": "null"
+              },
+              {
+                "$ref": "#/components/schemas/Something"
+              }
+            ]
+          }
+        },
+        "required": [
+          "someA"
+        ]
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0042__simple_recursive.json

@@ -0,0 +1,98 @@
+{
+  "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/ColumnSchema"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "parameters": []
+    }
+  },
+  "webhooks": {},
+  "components": {
+    "schemas": {
+      "ColumnMode": {
+        "type": "string",
+        "enum": [
+          "NULLABLE",
+          "REQUIRED",
+          "REPEATED"
+        ]
+      },
+      "ColumnSchema": {
+        "type": "object",
+        "properties": {
+          "description": {
+            "type": "string"
+          },
+          "mode": {
+            "$ref": "#/components/schemas/ColumnMode"
+          },
+          "name": {
+            "type": "string"
+          },
+          "subColumns": {
+            "items": {
+              "$ref": "#/components/schemas/ColumnSchema"
+            },
+            "type": "array"
+          },
+          "type": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "description",
+          "mode",
+          "name",
+          "type"
+        ]
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0043__gnarly_generic_example.json

@@ -1,5 +1,6 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.1.0",
+  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
   "info": {
     "title": "Test API",
     "version": "1.33.7",
@@ -26,59 +27,63 @@
     }
   ],
   "paths": {
-    "/test": {
+    "/": {
       "get": {
         "tags": [],
-        "summary": "Another get test",
+        "summary": "Great Summary!",
         "description": "testing more",
-        "operationId": "getTest",
+        "parameters": [],
-        "parameters": [
-          {
-            "name": "a",
-            "in": "path",
-            "schema": {
-              "type": "string"
-            },
-            "required": true,
-            "deprecated": false
-          },
-          {
-            "name": "aa",
-            "in": "query",
-            "schema": {
-              "format": "int32",
-              "type": "integer"
-            },
-            "required": true,
-            "deprecated": false
-          }
-        ],
         "responses": {
           "200": {
             "description": "A Successful Endeavor",
             "content": {
               "application/json": {
                 "schema": {
-                  "properties": {
+                  "$ref": "#/components/schemas/Foosy-Barzo-String"
-                    "c": {
-                      "type": "string"
-                    }
-                  },
-                  "required": [
-                    "c"
-                  ],
-                  "type": "object"
                 }
               }
             }
           }
         },
         "deprecated": false
-      }
+      },
+      "parameters": []
     }
   },
+  "webhooks": {},
   "components": {
-    "schemas": {},
+    "schemas": {
+      "Foosy-Barzo-String": {
+        "type": "object",
+        "properties": {
+          "otherThing": {
+            "items": {
+              "type": "string"
+            },
+            "type": "array"
+          },
+          "test": {
+            "$ref": "#/components/schemas/Barzo-Int"
+          }
+        },
+        "required": [
+          "otherThing",
+          "test"
+        ]
+      },
+      "Barzo-Int": {
+        "type": "object",
+        "properties": {
+          "result": {
+            "type": "number",
+            "format": "int32"
+          }
+        },
+        "required": [
+          "result"
+        ]
+      }
+    },
     "securitySchemes": {}
   },
   "security": [],

core/src/test/resources/T0044__nested_type_name.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/NestedResponse"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "parameters": []
+    }
+  },
+  "webhooks": {},
+  "components": {
+    "schemas": {
+      "NestedResponse": {
+        "type": "object",
+        "properties": {
+          "idk": {
+            "type": "boolean"
+          }
+        },
+        "required": [
+          "idk"
+        ]
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0045__default_auth_config.json

@@ -1,5 +1,6 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.1.0",
+  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
   "info": {
     "title": "Test API",
     "version": "1.33.7",
@@ -26,47 +27,19 @@
     }
   ],
   "paths": {
-    "/test": {
+    "/": {
       "get": {
         "tags": [],
-        "summary": "Another get test",
+        "summary": "Great Summary!",
         "description": "testing more",
-        "parameters": [
+        "parameters": [],
-          {
-            "name": "a",
-            "in": "path",
-            "schema": {
-              "type": "string"
-            },
-            "required": true,
-            "deprecated": false
-          },
-          {
-            "name": "aa",
-            "in": "query",
-            "schema": {
-              "format": "int32",
-              "type": "integer"
-            },
-            "required": true,
-            "deprecated": false
-          }
-        ],
         "responses": {
           "200": {
             "description": "A Successful Endeavor",
             "content": {
               "application/json": {
                 "schema": {
-                  "properties": {
+                  "$ref": "#/components/schemas/TestResponse"
-                    "c": {
-                      "type": "string"
-                    }
-                  },
-                  "required": [
-                    "c"
-                  ],
-                  "type": "object"
                 }
               }
             }
@@ -78,11 +51,25 @@
             "basic": []
           }
         ]
-      }
+      },
+      "parameters": []
     }
   },
+  "webhooks": {},
   "components": {
-    "schemas": {},
+    "schemas": {
+      "TestResponse": {
+        "type": "object",
+        "properties": {
+          "c": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "c"
+        ]
+      }
+    },
     "securitySchemes": {
       "basic": {
         "type": "http",

core/src/test/resources/T0046__custom_auth_config.json

@@ -0,0 +1,92 @@
+{
+  "openapi": "3.1.0",
+  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
+  "info": {
+    "title": "Test API",
+    "version": "1.33.7",
+    "description": "An amazing, fully-ish 😉 generated API spec",
+    "termsOfService": "https://example.com",
+    "contact": {
+      "name": "Homer Simpson",
+      "url": "https://gph.is/1NPUDiM",
+      "email": "chunkylover53@aol.com"
+    },
+    "license": {
+      "name": "MIT",
+      "url": "https://github.com/bkbnio/kompendium/blob/main/LICENSE"
+    }
+  },
+  "servers": [
+    {
+      "url": "https://myawesomeapi.com",
+      "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"
+            ]
+          }
+        ]
+      },
+      "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/T0047__multiple_auth_strategies.json

@@ -1,5 +1,6 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.1.0",
+  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
   "info": {
     "title": "Test API",
     "version": "1.33.7",
@@ -26,47 +27,19 @@
     }
   ],
   "paths": {
-    "/test": {
+    "/": {
       "get": {
         "tags": [],
-        "summary": "Another get test",
+        "summary": "Great Summary!",
         "description": "testing more",
-        "parameters": [
+        "parameters": [],
-          {
-            "name": "a",
-            "in": "path",
-            "schema": {
-              "type": "string"
-            },
-            "required": true,
-            "deprecated": false
-          },
-          {
-            "name": "aa",
-            "in": "query",
-            "schema": {
-              "format": "int32",
-              "type": "integer"
-            },
-            "required": true,
-            "deprecated": false
-          }
-        ],
         "responses": {
           "200": {
             "description": "A Successful Endeavor",
             "content": {
               "application/json": {
                 "schema": {
-                  "properties": {
+                  "$ref": "#/components/schemas/TestResponse"
-                    "c": {
-                      "type": "string"
-                    }
-                  },
-                  "required": [
-                    "c"
-                  ],
-                  "type": "object"
                 }
               }
             }
@@ -76,18 +49,40 @@
         "security": [
           {
             "jwt": []
+          },
+          {
+            "api-key": []
           }
         ]
-      }
+      },
+      "parameters": []
     }
   },
+  "webhooks": {},
   "components": {
-    "schemas": {},
+    "schemas": {
+      "TestResponse": {
+        "type": "object",
+        "properties": {
+          "c": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "c"
+        ]
+      }
+    },
     "securitySchemes": {
       "jwt": {
         "bearerFormat": "JWT",
         "type": "http",
         "scheme": "bearer"
+      },
+      "api-key": {
+        "in": "header",
+        "name": "X-API-KEY",
+        "type": "apiKey"
       }
     }
   },

core/src/test/resources/T0048__ignored_property.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/TransientObject"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "parameters": []
+    }
+  },
+  "webhooks": {},
+  "components": {
+    "schemas": {
+      "TransientObject": {
+        "type": "object",
+        "properties": {
+          "nonTransient": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "nonTransient"
+        ]
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0049__unbacked_property.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/UnbackedObject"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "parameters": []
+    }
+  },
+  "webhooks": {},
+  "components": {
+    "schemas": {
+      "UnbackedObject": {
+        "type": "object",
+        "properties": {
+          "backed": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "backed"
+        ]
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0050__custom_named_property.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/SerialNameObject"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "parameters": []
+    }
+  },
+  "webhooks": {},
+  "components": {
+    "schemas": {
+      "SerialNameObject": {
+        "type": "object",
+        "properties": {
+          "snake_case_name": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "snake_case_name"
+        ]
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0051__top_level_nullable.json

@@ -1,5 +1,6 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.1.0",
+  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
   "info": {
     "title": "Test API",
     "version": "1.33.7",
@@ -26,45 +27,51 @@
     }
   ],
   "paths": {
-    "/test/polymorphic": {
+    "/": {
       "get": {
         "tags": [],
-        "summary": "spooky class",
+        "summary": "Great Summary!",
-        "description": "break this glass in scenario of emergency",
+        "description": "testing more",
         "parameters": [],
         "responses": {
           "200": {
-            "description": "A successful endeavor",
+            "description": "A Successful Endeavor",
             "content": {
               "application/json": {
                 "schema": {
-                  "properties": {
+                  "oneOf": [
-                    "nowYouSeeMe": {
+                    {
-                      "type": "string"
+                      "type": "null"
                     },
-                    "nowYouDont": {
+                    {
-                      "enum": [
+                      "$ref": "#/components/schemas/TestResponse"
-                        "HAHA",
-                        "HOHO"
-                      ],
-                      "type": "string"
                     }
-                  },
+                  ]
-                  "required": [
-                    "nowYouSeeMe"
-                  ],
-                  "type": "object"
                 }
               }
             }
           }
         },
         "deprecated": false
-      }
+      },
+      "parameters": []
     }
   },
+  "webhooks": {},
   "components": {
-    "schemas": {},
+    "schemas": {
+      "TestResponse": {
+        "type": "object",
+        "properties": {
+          "c": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "c"
+        ]
+      }
+    },
     "securitySchemes": {}
   },
   "security": [],

core/src/test/resources/T0052__override_media_types.json

@@ -0,0 +1,123 @@
+{
+  "openapi": "3.1.0",
+  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
+  "info": {
+    "title": "Test API",
+    "version": "1.33.7",
+    "description": "An amazing, fully-ish 😉 generated API spec",
+    "termsOfService": "https://example.com",
+    "contact": {
+      "name": "Homer Simpson",
+      "url": "https://gph.is/1NPUDiM",
+      "email": "chunkylover53@aol.com"
+    },
+    "license": {
+      "name": "MIT",
+      "url": "https://github.com/bkbnio/kompendium/blob/main/LICENSE"
+    }
+  },
+  "servers": [
+    {
+      "url": "https://myawesomeapi.com",
+      "description": "Production instance of my API"
+    },
+    {
+      "url": "https://staging.myawesomeapi.com",
+      "description": "Where the fun stuff happens"
+    }
+  ],
+  "paths": {
+    "/media_types": {
+      "put": {
+        "tags": [],
+        "summary": "Great Summary!",
+        "description": "testing more",
+        "parameters": [],
+        "requestBody": {
+          "description": "A cool request",
+          "content": {
+            "multipart/form-data": {
+              "schema": {
+                "$ref": "#/components/schemas/TestRequest"
+              }
+            },
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/TestRequest"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "201": {
+            "description": "A good response",
+            "content": {
+              "application/xml": {
+                "schema": {
+                  "$ref": "#/components/schemas/TestResponse"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "parameters": []
+    }
+  },
+  "webhooks": {},
+  "components": {
+    "schemas": {
+      "TestResponse": {
+        "type": "object",
+        "properties": {
+          "c": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "c"
+        ]
+      },
+      "TestRequest": {
+        "type": "object",
+        "properties": {
+          "aaa": {
+            "items": {
+              "type": "number",
+              "format": "int64"
+            },
+            "type": "array"
+          },
+          "b": {
+            "type": "number",
+            "format": "double"
+          },
+          "fieldName": {
+            "$ref": "#/components/schemas/TestNested"
+          }
+        },
+        "required": [
+          "aaa",
+          "b",
+          "fieldName"
+        ]
+      },
+      "TestNested": {
+        "type": "object",
+        "properties": {
+          "nesty": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "nesty"
+        ]
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0053__same_path_different_methods_and_auth.json

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

core/src/test/resources/T0054__app_with_rootpath.json

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

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

@@ -0,0 +1,54 @@
+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/TestHelpers.kt

@@ -0,0 +1,139 @@
+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
+import io.bkbn.kompendium.json.schema.KotlinXSchemaConfigurator
+import io.bkbn.kompendium.json.schema.definition.JsonSchema
+import io.bkbn.kompendium.oas.OpenApiSpec
+import io.bkbn.kompendium.oas.serialization.KompendiumSerializersModule
+import io.kotest.assertions.json.shouldEqualJson
+import io.kotest.assertions.ktor.client.shouldHaveStatus
+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.plugins.contentnegotiation.ContentNegotiation
+import io.ktor.server.routing.Routing
+import io.ktor.server.testing.ApplicationTestBuilder
+import io.ktor.server.testing.testApplication
+import java.io.File
+import kotlinx.serialization.json.Json
+import kotlin.reflect.KType
+
+object TestHelpers {
+  private const val OPEN_API_ENDPOINT = "/openapi.json"
+
+  fun getFileSnapshot(fileName: String): String {
+    val snapshotPath = "src/test/resources"
+    val file = File("$snapshotPath/$fileName")
+    return file.readText()
+  }
+
+  /**
+   * Performs the baseline expected tests on an OpenAPI result.  Confirms that the endpoint
+   * exists as expected, and that the content matches the expected blob found in the specified file
+   * @param snapshotName The snapshot file to retrieve from the resources folder
+   */
+  private suspend fun ApplicationTestBuilder.compareOpenAPISpec(rootPath: String, snapshotName: String) {
+    val response = client.get("$rootPath$OPEN_API_ENDPOINT")
+    response shouldHaveStatus HttpStatusCode.OK
+    response.bodyAsText() shouldNot beBlank()
+    response.bodyAsText() shouldEqualJson getFileSnapshot(snapshotName)
+  }
+
+  /**
+   * 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
+   * @param snapshotName The snapshot file to retrieve from the resources folder
+   */
+  fun openApiTestAllSerializers(
+    snapshotName: String,
+    customTypes: Map<KType, JsonSchema> = emptyMap(),
+    applicationSetup: Application.() -> Unit = { },
+    specOverrides: OpenApiSpec.() -> OpenApiSpec = { this },
+    applicationEnvironmentBuilder: ApplicationEngineEnvironmentBuilder.() -> Unit = {},
+    routeUnderTest: Routing.() -> Unit
+  ) {
+    openApiTest(
+      snapshotName,
+      SupportedSerializer.KOTLINX,
+      routeUnderTest,
+      applicationSetup,
+      specOverrides,
+      customTypes,
+      applicationEnvironmentBuilder
+    )
+    openApiTest(
+      snapshotName,
+      SupportedSerializer.JACKSON,
+      routeUnderTest,
+      applicationSetup,
+      specOverrides,
+      customTypes,
+      applicationEnvironmentBuilder
+    )
+    openApiTest(
+      snapshotName,
+      SupportedSerializer.GSON,
+      routeUnderTest,
+      applicationSetup,
+      specOverrides,
+      customTypes,
+      applicationEnvironmentBuilder
+    )
+  }
+
+  private fun openApiTest(
+    snapshotName: String,
+    serializer: SupportedSerializer,
+    routeUnderTest: Routing.() -> Unit,
+    applicationSetup: Application.() -> Unit,
+    specOverrides: OpenApiSpec.() -> OpenApiSpec,
+    typeOverrides: Map<KType, JsonSchema> = emptyMap(),
+    applicationBuilder: ApplicationEngineEnvironmentBuilder.() -> Unit = {}
+  ) = testApplication {
+    environment(applicationBuilder)
+    install(NotarizedApplication()) {
+      customTypes = typeOverrides
+      spec = defaultSpec().specOverrides()
+      schemaConfigurator = when (serializer) {
+        SupportedSerializer.KOTLINX -> KotlinXSchemaConfigurator()
+        SupportedSerializer.GSON -> GsonSchemaConfigurator()
+        SupportedSerializer.JACKSON -> JacksonSchemaConfigurator()
+      }
+    }
+    install(ContentNegotiation) {
+      when (serializer) {
+        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)
+    routing {
+      redoc()
+      routeUnderTest()
+    }
+    val root = ApplicationEngineEnvironmentBuilder().apply(applicationBuilder).rootPath
+    compareOpenAPISpec(root, snapshotName)
+  }
+}

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

@@ -0,0 +1,189 @@
+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 java.time.Instant
+
+@Serializable
+data class TestNested(val nesty: String)
+
+@Serializable
+data class TestRequest(
+  val fieldName: TestNested,
+  val b: Double,
+  val aaa: List<Long>
+)
+
+@Serializable
+data class TestSimpleRequest(
+  val a: String,
+  val b: Int
+)
+
+@Serializable
+data class TestResponse(val c: String)
+
+@Serializable
+enum class TestEnum {
+  YES,
+  NO
+}
+
+@Serializable
+data class NullableEnum(val a: TestEnum? = null)
+
+data class TestCreatedResponse(val id: Int, val c: String)
+
+data class DateTimeString(
+  val a: Instant
+)
+
+data class DefaultField(
+  val a: String = "hi",
+  val b: Int
+)
+
+data class NullableField(
+  val a: String?
+)
+
+data class ComplexRequest(
+  val org: String,
+  val amazingField: String,
+  val tables: List<NestedComplexItem>
+)
+
+data class NestedComplexItem(
+  val name: String,
+  val alias: CustomAlias
+)
+
+typealias CustomAlias = Map<String, CrazyItem>
+
+data class CrazyItem(val enumeration: SimpleEnum)
+
+enum class SimpleEnum {
+  ONE,
+  TWO
+}
+
+data class ExceptionResponse(val message: String)
+
+sealed class FlibbityGibbit {
+  abstract val z: String
+}
+
+data class SimpleGibbit(val a: String, override val z: String = "z") : FlibbityGibbit()
+data class ComplexGibbit(val b: String, val c: Int, override val z: String) : FlibbityGibbit()
+
+sealed interface SlammaJamma
+
+data class OneJamma(val a: Int) : SlammaJamma
+data class AnothaJamma(val b: Float) : SlammaJamma
+
+data class InsaneJamma(val c: SlammaJamma) : SlammaJamma
+
+sealed interface Flibbity<T>
+
+data class Gibbity<T>(val a: T) : Flibbity<T>
+data class Bibbity<T>(val b: String, val f: T) : Flibbity<T>
+
+data class NestedFlibbity<T>(
+  val flibbity: Flibbity<T>
+)
+
+enum class ColumnMode {
+  NULLABLE,
+  REQUIRED,
+  REPEATED
+}
+
+data class ColumnSchema(
+  val name: String,
+  val type: String,
+  val description: String,
+  val mode: ColumnMode,
+  val subColumns: List<ColumnSchema> = emptyList()
+)
+
+@Serializable
+public data class ProfileUpdateRequest(
+  public val mood: String?,
+  public val viewCount: Long?,
+  public val metadata: ProfileMetadataUpdateRequest?
+)
+
+
+@Serializable
+public data class ProfileMetadataUpdateRequest(
+  public val isPrivate: Boolean?,
+  public val otherThing: String?
+)
+
+data class Page<T>(
+  val content: List<T>,
+  val totalElements: Long,
+  val totalPages: Int,
+  val numberOfElements: Int,
+  val number: Int,
+  val size: Int
+)
+
+data class MultiNestedGenerics<T, E>(
+  val content: Map<T, E>
+)
+
+data class Something(val a: String, val b: Int)
+
+data class ManyThings(
+  val someA: Something,
+  val someB: Something?
+)
+
+data class Foosy<T, K>(val test: T, val otherThing: List<K>)
+data class Barzo<G>(val result: G)
+
+object Nested {
+  @Serializable
+  data class Response(val idk: Boolean)
+}
+
+@Serializable
+data class TransientObject(
+  @field:Expose
+  val nonTransient: String,
+  @field:JsonIgnore
+  @Transient
+  val transient: String = "transient"
+)
+
+@Serializable
+data class UnbackedObject(
+  val backed: String
+) {
+  val unbacked: String get() = "unbacked"
+}
+
+@Serializable
+data class SerialNameObject(
+  @field:JsonProperty("snake_case_name")
+  @field:SerializedName("snake_case_name")
+  @SerialName("snake_case_name")
+  val camelCaseName: String
+)
+
+enum class Color {
+  RED,
+  GREEN,
+  BLUE
+}
+
+@Serializable
+data class ObjectWithEnum(
+  val color: Color
+)

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

@@ -1,44 +1,19 @@
 package io.bkbn.kompendium.core.fixtures
 
-import com.fasterxml.jackson.annotation.JsonInclude
-import com.fasterxml.jackson.databind.SerializationFeature
-import io.bkbn.kompendium.core.Kompendium
-import io.bkbn.kompendium.core.routes.redoc
 import io.bkbn.kompendium.oas.OpenApiSpec
 import io.bkbn.kompendium.oas.info.Contact
 import io.bkbn.kompendium.oas.info.Info
 import io.bkbn.kompendium.oas.info.License
 import io.bkbn.kompendium.oas.server.Server
-import io.ktor.application.Application
-import io.ktor.application.install
-import io.ktor.features.ContentNegotiation
-import io.ktor.http.ContentType
-import io.ktor.jackson.jackson
-import io.ktor.routing.routing
 import java.net.URI
 
-fun Application.docs() {
+object TestSpecs {
-  routing {
+  val defaultSpec: () -> OpenApiSpec = {
-    redoc()
+    OpenApiSpec(
-  }
-}
-
-fun Application.jacksonConfigModule() {
-  install(ContentNegotiation) {
-    jackson(ContentType.Application.Json) {
-      enable(SerializationFeature.INDENT_OUTPUT)
-      setSerializationInclusion(JsonInclude.Include.NON_NULL)
-    }
-  }
-}
-
-fun Application.kompendium() {
-  install(Kompendium) {
-    spec = OpenApiSpec(
       info = Info(
         title = "Test API",
         version = "1.33.7",
-        description = "An amazing, fully-ish 😉 generated API spec",
+        description = "An amazing, fully-ish \uD83D\uDE09 generated API spec",
         termsOfService = URI("https://example.com"),
         contact = Contact(
           name = "Homer Simpson",