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

fix: enum type def (#563)

Browse Source
This commit is contained in:
Ryan Brink
2024-01-17 16:14:47 -05:00
committed by GitHub
parent 3d1fc566d4
commit 353637bb94
25 changed files with 121 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -60,6 +60,7 @@ import io.bkbn.kompendium.core.util.primitives
import io.bkbn.kompendium.core.util.reqRespExamples
import io.bkbn.kompendium.core.util.requiredParams
import io.bkbn.kompendium.core.util.responseHeaders
import io.bkbn.kompendium.core.util.returnsEnumList
import io.bkbn.kompendium.core.util.returnsList
import io.bkbn.kompendium.core.util.rootRoute
import io.bkbn.kompendium.core.util.samePathDifferentMethodsAndAuth
@ -295,6 +296,9 @@ class KompendiumTest : DescribeSpec({
it("Can have a nullable enum as a member field") {
openApiTestAllSerializers("T0037__nullable_enum_field.json") { nullableEnumField() }
}
it("Can have a list of enums as a field") {
openApiTestAllSerializers("T0076__list_of_enums.json") { returnsEnumList() }
}
it("Can have a nullable reference without impacting base type") {
openApiTestAllSerializers("T0041__nullable_reference.json") { nullableReference() }
}

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

@ -3,6 +3,7 @@ package io.bkbn.kompendium.core.util
import io.bkbn.kompendium.core.fixtures.ComplexRequest
import io.bkbn.kompendium.core.fixtures.SomethingSimilar
import io.bkbn.kompendium.core.fixtures.TestCreatedResponse
import io.bkbn.kompendium.core.fixtures.TestEnum
import io.bkbn.kompendium.core.fixtures.TestRequest
import io.bkbn.kompendium.core.fixtures.TestResponse
import io.bkbn.kompendium.core.fixtures.TestSimpleRequest
@ -284,6 +285,23 @@ fun Routing.returnsList() {
}
}
fun Routing.returnsEnumList() {
route(defaultPath) {
install(NotarizedRoute()) {
parameters = defaultParams
get = GetInfo.builder {
summary(defaultPathSummary)
description(defaultPathDescription)
response {
description("A Successful List-y Endeavor")
responseCode(HttpStatusCode.OK)
responseType<List<TestEnum>>()
}
}
}
}
}
fun Routing.nonRequiredParams() {
route("/optional") {
install(NotarizedRoute()) {

1
core/src/test/resources/T0008__complex_type.json
View File

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

2
core/src/test/resources/T0018__polymorphic_error_status_codes.json
View File

@ -88,7 +88,6 @@
"type": "string"
},
"type": {
"type": "string",
"enum": [
"io.bkbn.kompendium.core.fixtures.ComplexGibbit"
]
@ -111,7 +110,6 @@
"type": "string"
},
"type": {
"type": "string",
"enum": [
"io.bkbn.kompendium.core.fixtures.SimpleGibbit"
]

2
core/src/test/resources/T0019__generic_exception.json
View File

@ -84,7 +84,6 @@
"type": "string"
},
"type": {
"type": "string",
"enum": [
"io.bkbn.kompendium.core.fixtures.Bibbity"
]
@ -103,7 +102,6 @@
"type": "string"
},
"type": {
"type": "string",
"enum": [
"io.bkbn.kompendium.core.fixtures.Gibbity"
]

2
core/src/test/resources/T0027__polymorphic_response.json
View File

@ -67,7 +67,6 @@
"type": "string"
},
"type": {
"type": "string",
"enum": [
"io.bkbn.kompendium.core.fixtures.ComplexGibbit"
]
@ -90,7 +89,6 @@
"type": "string"
},
"type": {
"type": "string",
"enum": [
"io.bkbn.kompendium.core.fixtures.SimpleGibbit"
]

2
core/src/test/resources/T0028__polymorphic_list_response.json
View File

@ -67,7 +67,6 @@
"type": "string"
},
"type": {
"type": "string",
"enum": [
"io.bkbn.kompendium.core.fixtures.ComplexGibbit"
]
@ -90,7 +89,6 @@
"type": "string"
},
"type": {
"type": "string",
"enum": [
"io.bkbn.kompendium.core.fixtures.SimpleGibbit"
]

2
core/src/test/resources/T0029__polymorphic_map_response.json
View File

@ -67,7 +67,6 @@
"type": "string"
},
"type": {
"type": "string",
"enum": [
"io.bkbn.kompendium.core.fixtures.ComplexGibbit"
]
@ -90,7 +89,6 @@
"type": "string"
},
"type": {
"type": "string",
"enum": [
"io.bkbn.kompendium.core.fixtures.SimpleGibbit"
]

2
core/src/test/resources/T0032__polymorphic_response_with_generics.json
View File

@ -64,7 +64,6 @@
"format": "double"
},
"type": {
"type": "string",
"enum": [
"io.bkbn.kompendium.core.fixtures.Bibbity"
]
@ -84,7 +83,6 @@
"format": "double"
},
"type": {
"type": "string",
"enum": [
"io.bkbn.kompendium.core.fixtures.Gibbity"
]

4
core/src/test/resources/T0033__crazy_polymorphic_example.json
View File

@ -70,7 +70,6 @@
]
},
"type": {
"type": "string",
"enum": [
"io.bkbn.kompendium.core.fixtures.Bibbity"
]
@ -96,7 +95,6 @@
"type": "string"
},
"type": {
"type": "string",
"enum": [
"io.bkbn.kompendium.core.fixtures.ComplexGibbit"
]
@ -119,7 +117,6 @@
"type": "string"
},
"type": {
"type": "string",
"enum": [
"io.bkbn.kompendium.core.fixtures.SimpleGibbit"
]
@ -144,7 +141,6 @@
]
},
"type": {
"type": "string",
"enum": [
"io.bkbn.kompendium.core.fixtures.Gibbity"
]

1
core/src/test/resources/T0037__nullable_enum_field.json
View File

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

1
core/src/test/resources/T0040__nested_generic_multiple_type_params.json
View File

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

1
core/src/test/resources/T0042__simple_recursive.json
View File

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

1
core/src/test/resources/T0056__enriched_nested_collection.json
View File

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

1
core/src/test/resources/T0057__enriched_complex_generic_type.json
View File

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

2
core/src/test/resources/T0070__sealed_interface_type_name_override.json
View File

@ -60,7 +60,6 @@
"type": "string"
},
"type": {
"type": "string",
"enum": [
"chillax"
]
@ -79,7 +78,6 @@
"format": "int32"
},
"type": {
"type": "string",
"enum": [
"maximize"
]

93
core/src/test/resources/T0076__list_of_enums.json Normal file
View File

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

2
json-schema/src/main/kotlin/io/bkbn/kompendium/json/schema/KotlinXSchemaConfigurator.kt
View File

@ -35,7 +35,7 @@ class KotlinXSchemaConfigurator : SchemaConfigurator {
required = implementationSchema.required?.plus("type"),
properties = implementationSchema.properties?.plus(
mapOf(
"type" to EnumDefinition("string", enum = setOf(determineTypeQualifier(implementationType)))
"type" to EnumDefinition(enum = setOf(determineTypeQualifier(implementationType)))
)
)
)

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

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

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

@ -4,6 +4,7 @@ import io.bkbn.kompendium.enrichment.TypeEnrichment
import io.bkbn.kompendium.json.schema.SchemaConfigurator
import io.bkbn.kompendium.json.schema.SchemaGenerator
import io.bkbn.kompendium.json.schema.definition.ArrayDefinition
import io.bkbn.kompendium.json.schema.definition.EnumDefinition
import io.bkbn.kompendium.json.schema.definition.JsonSchema
import io.bkbn.kompendium.json.schema.definition.NullableDefinition
import io.bkbn.kompendium.json.schema.definition.OneOfDefinition
@ -23,7 +24,7 @@ object CollectionHandler {
val collectionType = type.arguments.first().type
?: error("This indicates a bug in Kompendium, please open a GitHub issue!")
val typeSchema = SchemaGenerator.fromTypeToSchema(collectionType, cache, schemaConfigurator, enrichment).let {
if (it is TypeDefinition && it.type == "object") {
if ((it is TypeDefinition && it.type == "object") || it is EnumDefinition) {
cache[collectionType.getSlug(enrichment)] = it
ReferenceDefinition(collectionType.getReferenceSlug(enrichment))
} else {

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

@ -19,6 +19,6 @@ object EnumHandler {
cache[type.getSlug(enrichment)] = ReferenceDefinition(type.getReferenceSlug(enrichment))
val options = clazz.java.enumConstants.map { it.toString() }.toSet()
return EnumDefinition(type = "string", enum = options)
return EnumDefinition(enum = options)
}
}

3
json-schema/src/test/resources/T0007__simple_enum.json
View File

@ -1,4 +1,3 @@
{
"enum": [ "ONE", "TWO" ],
"type": "string"
"enum": [ "ONE", "TWO" ]
}

3
json-schema/src/test/resources/T0008__nullable_enum.json
View File

@ -1,4 +1,3 @@
{
"enum": [ "ONE", "TWO" ],
"type": "string"
"enum": [ "ONE", "TWO" ]
}

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

@ -148,7 +148,6 @@ fun fromTypeToSchema(
Descriptors.FieldDescriptor.JavaType.BYTE_STRING -> TypeDefinition.STRING
Descriptors.FieldDescriptor.JavaType.ENUM -> {
cache[javaProtoField.enumType.fullName] = EnumDefinition(
type = "string",
enum = javaProtoField.enumType.values.map { it.name }.toSet()
)
ReferenceDefinition("${Helpers.COMPONENT_SLUG}/${javaProtoField.enumType.name}")

1
protobuf-java-converter/src/test/resources/T0002__enummessage_post.json
View File

@ -66,7 +66,6 @@
}
},
"Corpus": {
"type": "string",
"enum": [
"CORPUS_UNSPECIFIED",
"CORPUS_UNIVERSAL",