naijun0403/kompendium
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

fix: improved error output when an unknown schema is encountered (#327)

Browse Source
This commit is contained in:
Ryan Brink
2022-09-26 08:15:21 -05:00
committed by GitHub
parent b3dcf7dc8b
commit 70345494ab
6 changed files with 36 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
json-schema/src/main/kotlin/io/bkbn/kompendium/json/schema/exception/UnknownSchemaException.kt Normal file
View File

@ -0,0 +1,3 @@
package io.bkbn.kompendium.json.schema.exception
class UnknownSchemaException(message: String) : Exception(message)

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

@ -7,6 +7,7 @@ import io.bkbn.kompendium.json.schema.definition.NullableDefinition
import io.bkbn.kompendium.json.schema.definition.OneOfDefinition
import io.bkbn.kompendium.json.schema.definition.ReferenceDefinition
import io.bkbn.kompendium.json.schema.definition.TypeDefinition
import io.bkbn.kompendium.json.schema.exception.UnknownSchemaException
import io.bkbn.kompendium.json.schema.util.Helpers.getReferenceSlug
import io.bkbn.kompendium.json.schema.util.Helpers.getSimpleSlug
import kotlin.reflect.KClass
@ -53,7 +54,20 @@ object SimpleObjectHandler {
.asSequence()
.filterNot { it.javaField == null }
.filterNot { prop -> prop.returnType.isMarkedNullable }
.filterNot { prop -> clazz.primaryConstructor!!.parameters.find { it.name == prop.name }!!.isOptional }
.filterNot { prop ->
clazz.primaryConstructor
?.parameters
?.find { it.name == prop.name }
?.isOptional
?: throw UnknownSchemaException(
"""
|An unknown type was encountered: $clazz. This typically indicates that a complex scalar such as dates,
|timestamps, or custom number representations such as BigInteger were not added as custom types when
|configuring the NotarizedApplication plugin. If you are still seeing this error despite adding all
|required custom types, this indicates a bug in Kompendium, please open an issue on GitHub.
""".trimMargin()
)
}
.map { schemaConfigurator.serializableName(it) }
.toSet()