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

fix: add missing mapping of BooleanEnrichment to EnrichmentHandler (#655)

Browse Source
This commit is contained in:
Johannes Hoppenstedt
2024-11-11 20:33:45 +01:00
committed by GitHub
parent 4a9165fd3a
commit 636bf65c36
15 changed files with 89 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
CHANGELOG.md
View File

@ -6,6 +6,10 @@
### Changed
### Fixed
- Fixed missing `BooleanEnrichment` mapping
### Remove
---

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

@ -10,6 +10,7 @@ import io.bkbn.kompendium.core.fixtures.TestSimpleRequest
import io.bkbn.kompendium.core.metadata.GetInfo
import io.bkbn.kompendium.core.metadata.PostInfo
import io.bkbn.kompendium.core.plugin.NotarizedRoute
import io.bkbn.kompendium.enrichment.BooleanEnrichment
import io.bkbn.kompendium.enrichment.CollectionEnrichment
import io.bkbn.kompendium.enrichment.MapEnrichment
import io.bkbn.kompendium.enrichment.NumberEnrichment
@ -63,6 +64,9 @@ fun Route.enrichedSimpleRequest() {
deprecated = true
}
}
TestSimpleRequest::c {
BooleanEnrichment("blah-blah-blah") { }
}
}
)
description("A test request")

6
core/src/test/resources/T0002__notarized_post.json
View File

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

6
core/src/test/resources/T0003__notarized_put.json
View File

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

6
core/src/test/resources/T0005__notarized_patch.json
View File

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

6
core/src/test/resources/T0053__same_path_different_methods_and_auth.json
View File

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

6
core/src/test/resources/T0055__enriched_simple_request.json
View File

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

6
core/src/test/resources/T0067__enriched_generic_object.json
View File

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

12
core/src/test/resources/T0077__enriched_top_level_list.json
View File

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

12
core/src/test/resources/T0078__enriched_top_level_map.json
View File

@ -64,11 +64,15 @@
"type": "number",
"format": "int32",
"deprecated": true
},
"c": {
"type": "boolean"
}
},
"required": [
"a",
"b"
"b",
"c"
]
},
"TestSimpleRequest-blah": {
@ -82,11 +86,15 @@
"type": "number",
"format": "int32",
"deprecated": true
},
"c": {
"type": "boolean"
}
},
"required": [
"a",
"b"
"b",
"c"
]
},
"Map-String-TestSimpleRequest-blah": {

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

@ -23,7 +23,8 @@ data class TestRequest(
@Serializable
data class TestSimpleRequest(
val a: String,
val b: Int
val b: Int,
val c: Boolean
)
@Serializable

14
json-schema/src/main/kotlin/io/bkbn/kompendium/json/schema/handler/EnrichmentHandler.kt
View File

@ -1,5 +1,6 @@
package io.bkbn.kompendium.json.schema.handler
import io.bkbn.kompendium.enrichment.BooleanEnrichment
import io.bkbn.kompendium.enrichment.CollectionEnrichment
import io.bkbn.kompendium.enrichment.Enrichment
import io.bkbn.kompendium.enrichment.MapEnrichment
@ -15,6 +16,7 @@ import io.bkbn.kompendium.json.schema.definition.TypeDefinition
object EnrichmentHandler {
fun Enrichment.applyToSchema(schema: JsonSchema): JsonSchema = when (this) {
is BooleanEnrichment -> applyToSchema(schema)
is NumberEnrichment -> applyToSchema(schema)
is StringEnrichment -> applyToSchema(schema)
is CollectionEnrichment<*> -> applyToSchema(schema)
@ -39,6 +41,11 @@ object EnrichmentHandler {
else -> error("Incorrect enrichment type for enrichment id: ${this.id}")
}
private fun BooleanEnrichment.applyToSchema(schema: JsonSchema): JsonSchema = when (schema) {
is TypeDefinition -> schema.copyBooleanEnrichment(this)
else -> error("Incorrect enrichment type for enrichment id: ${this.id}")
}
private fun NumberEnrichment.applyToSchema(schema: JsonSchema): JsonSchema = when (schema) {
is TypeDefinition -> schema.copyNumberEnrichment(this)
else -> error("Incorrect enrichment type for enrichment id: ${this.id}")
@ -49,6 +56,13 @@ object EnrichmentHandler {
else -> error("Incorrect enrichment type for enrichment id: ${this.id}")
}
private fun TypeDefinition.copyBooleanEnrichment(
enrichment: BooleanEnrichment
): TypeDefinition = copy(
deprecated = enrichment.deprecated,
description = enrichment.description,
)
private fun TypeDefinition.copyNumberEnrichment(
enrichment: NumberEnrichment
): TypeDefinition = copy(

6
json-schema/src/test/resources/T0004__simple_object.json
View File

@ -7,10 +7,14 @@
"b": {
"type": "number",
"format": "int32"
},
"c": {
"type": "boolean"
}
},
"required": [
"a",
"b"
"b",
"c"
]
}

6
json-schema/src/test/resources/T0006__nullable_object.json
View File

@ -7,10 +7,14 @@
"b": {
"type": "number",
"format": "int32"
},
"c": {
"type": "boolean"
}
},
"required": [
"a",
"b"
"b",
"c"
]
}

6
json-schema/src/test/resources/T0022__enriched_simple_object.json
View File

@ -9,10 +9,14 @@
"type": "number",
"format": "int32",
"deprecated": true
},
"c": {
"type": "boolean"
}
},
"required": [
"a",
"b"
"b",
"c"
]
}