Compare commits

..

37 Commits

Author SHA1 Message Date
91bf93a866 feat: type enrichment (#408) 2023-01-04 21:32:31 -05:00
73fb8b137f fix(deps): update dependency org.jetbrains.kotlin:kotlin-reflect to v1.8.0 (#405)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-12-28 22:11:08 +00:00
d3d6e79329 fix(deps): update dependency com.google.protobuf:protobuf-java to v3.21.12 (#402)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-12-15 10:02:49 +00:00
f2b7d924e0 fix(deps): update dependency org.slf4j:slf4j-simple to v2.0.6 (#401)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-12-13 10:38:53 +00:00
f62010b4e7 fix(deps): update dependency org.slf4j:slf4j-api to v2.0.6 (#400)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-12-13 07:39:57 +00:00
5bd1534270 fix(deps): update dependency com.google.protobuf:protobuf-java to v3.21.11 (#398)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-12-08 22:19:05 +00:00
4c151ffeea fix(deps): update dependency joda-time:joda-time to v2.12.2 (#396)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-12-01 18:21:42 +00:00
08a0d2e47c fix(deps): update dependency com.google.protobuf:protobuf-java to v3.21.10 (#395)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-12-01 09:58:10 +00:00
f19476d3a3 chore: bump gradle version 2022-11-30 12:48:46 -05:00
8ede53fd5c fix(deps): update dependency org.jetbrains.kotlin:kotlin-reflect to v1.7.22 (#394)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-11-28 21:50:54 +00:00
31a9f44ec1 chore(deps): update plugin org.jetbrains.kotlin.plugin.serialization to v1.7.22 (#393)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-11-28 15:31:11 +00:00
0eb2f126b3 chore(deps): update plugin org.jetbrains.kotlin.jvm to v1.7.22 (#392)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-11-28 15:24:18 +00:00
0d658bd6a8 fix(deps): update dependency org.slf4j:slf4j-simple to v2.0.5 (#390)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-11-25 19:01:28 +00:00
e924671c2b fix(deps): update dependency org.slf4j:slf4j-api to v2.0.5 (#389)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-11-25 18:54:39 +00:00
04996631b9 fix(deps): update dependency ch.qos.logback:logback-classic to v1.4.5 (#387)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-11-19 06:38:07 +00:00
82d80873c8 fix(deps): update dependency org.slf4j:slf4j-simple to v2.0.4 (#386)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-11-18 09:50:16 +00:00
487eaba741 fix(deps): update dependency org.slf4j:slf4j-api to v2.0.4 (#385)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-11-18 06:42:30 +00:00
b935cc1e1d chore: prep for 3.9.0 release 2022-11-15 20:49:58 -05:00
9f2d2dd4e3 fix: do not include rootPath in serialized route path 2022-11-16 01:46:29 +00:00
20f8a4f08f feat: protobuf java converters (#382) 2022-11-15 15:50:26 -05:00
7b39e448bf chore: prep for 3.8.0 release 2022-11-09 08:13:42 -05:00
3c57c8f5e4 feat: NotarizedResource plugin 2022-11-09 08:11:42 -05:00
01b6b59cf5 feat: support partial authentication (#372) (#375) 2022-11-08 19:59:35 +00:00
2c1c8fbcdc chore(deps): update plugin org.jetbrains.kotlin.plugin.serialization to v1.7.21 (#377)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Ryan Brink <5607577+unredundant@users.noreply.github.com>
2022-11-08 14:56:33 -05:00
0dc2b9538f chore: delete autoupdate action
this thing sucks meant to delete it a while ago
2022-11-08 14:42:30 -05:00
1ca7abaf0d fix(deps): update kotlin monorepo to v1.7.21 (#374)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-11-08 18:59:49 +00:00
a5376cfa82 feat: allow media type overrides (#369) 2022-11-05 16:45:06 -04:00
2492661f1f chore: prep for release 2022-11-05 16:11:38 -04:00
a7b52ec114 feat: create schema reference for enum types (#368) 2022-11-05 16:09:06 -04:00
8ebab04a83 fix(deps): update kotestversion to v5.5.4 (#363)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-11-04 06:00:41 +00:00
921f6f9691 fix(deps): update dependency dev.forst:ktor-api-key to v2.1.3 (#361)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-10-31 22:25:14 +00:00
558b9fea62 fix(deps): update ktor to v2.1.3 (#360)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-10-31 17:01:30 +00:00
752cb238d3 fix(deps): update dependency joda-time:joda-time to v2.12.1 (#359)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-10-30 06:12:11 +00:00
92d4760dbc chore: prep for 3.5.0 release 2022-10-29 08:16:03 -04:00
4946a27327 feat: add plugin to support ktor-server-resources (#358) 2022-10-29 08:14:32 -04:00
e4217843b7 fix(deps): update dependency io.ktor:ktor-server-content-negotiation to v2.1.3 (#357)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-10-28 14:38:54 +00:00
b8f2090a8a fix(deps): update kotestversion to v5.5.3 (#355)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-10-28 05:47:04 +00:00
119 changed files with 12433 additions and 1011 deletions

View File

@ -1,12 +0,0 @@
name: autoupdate
on:
push:
branches: [ main ]
jobs:
autoupdate:
name: autoupdate
runs-on: ubuntu-latest
steps:
- uses: docker://chinthakagodawita/autoupdate-action:v1
env:
GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'

View File

@ -12,6 +12,51 @@
## Released ## Released
## [3.10.0] - January 4th, 2023
### Added
- Support for type enrichments! `deprecated` and `description` to start
## [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 ## [3.4.0] - October 26th, 2022
### Added ### Added

View File

@ -1,6 +1,6 @@
plugins { plugins {
kotlin("jvm") version "1.7.20" apply false kotlin("jvm") version "1.8.0" apply false
kotlin("plugin.serialization") version "1.7.20" apply false kotlin("plugin.serialization") version "1.8.0" apply false
id("io.bkbn.sourdough.library.jvm") version "0.12.0" apply false id("io.bkbn.sourdough.library.jvm") version "0.12.0" apply false
id("io.bkbn.sourdough.application.jvm") version "0.12.0" apply false id("io.bkbn.sourdough.application.jvm") version "0.12.0" apply false
id("io.bkbn.sourdough.root") version "0.12.0" id("io.bkbn.sourdough.root") version "0.12.0"

View File

@ -33,7 +33,7 @@ dependencies {
implementation("io.ktor:ktor-server-html-builder:$ktorVersion") implementation("io.ktor:ktor-server-html-builder:$ktorVersion")
implementation("io.ktor:ktor-server-content-negotiation:$ktorVersion") implementation("io.ktor:ktor-server-content-negotiation:$ktorVersion")
implementation("io.ktor:ktor-serialization-kotlinx-json:$ktorVersion") implementation("io.ktor:ktor-serialization-kotlinx-json:$ktorVersion")
implementation("ch.qos.logback:logback-classic:1.4.4") implementation("ch.qos.logback:logback-classic:1.4.5")
// Formatting // Formatting
detektPlugins("io.gitlab.arturbosch.detekt:detekt-formatting:$detektVersion") detektPlugins("io.gitlab.arturbosch.detekt:detekt-formatting:$detektVersion")
@ -58,7 +58,7 @@ dependencies {
testFixturesApi("io.ktor:ktor-client:$ktorVersion") testFixturesApi("io.ktor:ktor-client:$ktorVersion")
testFixturesApi("io.ktor:ktor-client-cio:$ktorVersion") testFixturesApi("io.ktor:ktor-client-cio:$ktorVersion")
testFixturesApi("dev.forst:ktor-api-key:2.1.2") testFixturesApi("dev.forst:ktor-api-key:2.1.3")
testFixturesApi("org.jetbrains.kotlinx:kotlinx-serialization-json:1.4.1") testFixturesApi("org.jetbrains.kotlinx:kotlinx-serialization-json:1.4.1")
} }

View File

@ -1,13 +1,16 @@
package io.bkbn.kompendium.core.metadata package io.bkbn.kompendium.core.metadata
import io.bkbn.kompendium.enrichment.TypeEnrichment
import io.bkbn.kompendium.oas.payload.MediaType import io.bkbn.kompendium.oas.payload.MediaType
import kotlin.reflect.KType import kotlin.reflect.KType
import kotlin.reflect.typeOf import kotlin.reflect.typeOf
class RequestInfo private constructor( class RequestInfo private constructor(
val requestType: KType, val requestType: KType,
val typeEnrichment: TypeEnrichment<*>?,
val description: String, val description: String,
val examples: Map<String, MediaType.Example>? val examples: Map<String, MediaType.Example>?,
val mediaTypes: Set<String>
) { ) {
companion object { companion object {
@ -20,14 +23,23 @@ class RequestInfo private constructor(
class Builder { class Builder {
private var requestType: KType? = null private var requestType: KType? = null
private var typeEnrichment: TypeEnrichment<*>? = null
private var description: String? = null private var description: String? = null
private var examples: Map<String, MediaType.Example>? = null private var examples: Map<String, MediaType.Example>? = null
private var mediaTypes: Set<String>? = null
fun requestType(t: KType) = apply { fun requestType(t: KType) = apply {
this.requestType = t this.requestType = t
} }
inline fun <reified T> requestType() = apply { requestType(typeOf<T>()) } fun enrichment(t: TypeEnrichment<*>) = apply {
this.typeEnrichment = t
}
inline fun <reified T> requestType(enrichment: TypeEnrichment<T>? = null) = apply {
requestType(typeOf<T>())
enrichment?.let { enrichment(it) }
}
fun description(s: String) = apply { this.description = s } fun description(s: String) = apply { this.description = s }
@ -35,10 +47,16 @@ class RequestInfo private constructor(
this.examples = e.toMap().mapValues { (_, v) -> MediaType.Example(v) } this.examples = e.toMap().mapValues { (_, v) -> MediaType.Example(v) }
} }
fun mediaTypes(vararg m: String) = apply {
this.mediaTypes = m.toSet()
}
fun build() = RequestInfo( fun build() = RequestInfo(
requestType = requestType ?: error("Request type must be present"), requestType = requestType ?: error("Request type must be present"),
description = description ?: error("Description must be present"), description = description ?: error("Description must be present"),
examples = examples typeEnrichment = typeEnrichment,
examples = examples,
mediaTypes = mediaTypes ?: setOf("application/json")
) )
} }
} }

View File

@ -1,5 +1,6 @@
package io.bkbn.kompendium.core.metadata package io.bkbn.kompendium.core.metadata
import io.bkbn.kompendium.enrichment.TypeEnrichment
import io.bkbn.kompendium.oas.payload.MediaType import io.bkbn.kompendium.oas.payload.MediaType
import io.ktor.http.HttpStatusCode import io.ktor.http.HttpStatusCode
import kotlin.reflect.KType import kotlin.reflect.KType
@ -8,8 +9,10 @@ import kotlin.reflect.typeOf
class ResponseInfo private constructor( class ResponseInfo private constructor(
val responseCode: HttpStatusCode, val responseCode: HttpStatusCode,
val responseType: KType, val responseType: KType,
val typeEnrichment: TypeEnrichment<*>?,
val description: String, val description: String,
val examples: Map<String, MediaType.Example>? val examples: Map<String, MediaType.Example>?,
val mediaTypes: Set<String>
) { ) {
companion object { companion object {
@ -23,8 +26,10 @@ class ResponseInfo private constructor(
class Builder { class Builder {
private var responseCode: HttpStatusCode? = null private var responseCode: HttpStatusCode? = null
private var responseType: KType? = null private var responseType: KType? = null
private var typeEnrichment: TypeEnrichment<*>? = null
private var description: String? = null private var description: String? = null
private var examples: Map<String, MediaType.Example>? = null private var examples: Map<String, MediaType.Example>? = null
private var mediaTypes: Set<String>? = null
fun responseCode(code: HttpStatusCode) = apply { fun responseCode(code: HttpStatusCode) = apply {
this.responseCode = code this.responseCode = code
@ -34,7 +39,14 @@ class ResponseInfo private constructor(
this.responseType = t this.responseType = t
} }
inline fun <reified T> responseType() = apply { responseType(typeOf<T>()) } fun enrichment(t: TypeEnrichment<*>) = apply {
this.typeEnrichment = t
}
inline fun <reified T> responseType(enrichment: TypeEnrichment<T>? = null) = apply {
responseType(typeOf<T>())
enrichment?.let { enrichment(it) }
}
fun description(s: String) = apply { this.description = s } fun description(s: String) = apply { this.description = s }
@ -42,11 +54,17 @@ class ResponseInfo private constructor(
this.examples = e.toMap().mapValues { (_, v) -> MediaType.Example(v) } this.examples = e.toMap().mapValues { (_, v) -> MediaType.Example(v) }
} }
fun mediaTypes(vararg m: String) = apply {
this.mediaTypes = m.toSet()
}
fun build() = ResponseInfo( fun build() = ResponseInfo(
responseCode = responseCode ?: error("You must provide a response code in order to build a Response!"), 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!"), 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!"), description = description ?: error("You must provide a description in order to build a Response!"),
examples = examples typeEnrichment = typeEnrichment,
examples = examples,
mediaTypes = mediaTypes ?: setOf("application/json")
) )
} }
} }

View File

@ -10,16 +10,17 @@ import io.bkbn.kompendium.core.metadata.PostInfo
import io.bkbn.kompendium.core.metadata.PutInfo import io.bkbn.kompendium.core.metadata.PutInfo
import io.bkbn.kompendium.core.util.Helpers.addToSpec import io.bkbn.kompendium.core.util.Helpers.addToSpec
import io.bkbn.kompendium.core.util.SpecConfig 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.path.Path
import io.bkbn.kompendium.oas.path.PathOperation
import io.bkbn.kompendium.oas.payload.Parameter import io.bkbn.kompendium.oas.payload.Parameter
import io.ktor.server.application.ApplicationCallPipeline import io.ktor.server.application.ApplicationCallPipeline
import io.ktor.server.application.Hook import io.ktor.server.application.Hook
import io.ktor.server.application.PluginBuilder
import io.ktor.server.application.createRouteScopedPlugin import io.ktor.server.application.createRouteScopedPlugin
import io.ktor.server.routing.Route import io.ktor.server.routing.Route
import io.ktor.server.routing.application
object NotarizedRoute { object NotarizedRoute {
class Config : SpecConfig { class Config : SpecConfig {
override var tags: Set<String> = emptySet() override var tags: Set<String> = emptySet()
override var parameters: List<Parameter> = emptyList() override var parameters: List<Parameter> = emptyList()
@ -31,7 +32,6 @@ object NotarizedRoute {
override var head: HeadInfo? = null override var head: HeadInfo? = null
override var options: OptionsInfo? = null override var options: OptionsInfo? = null
override var security: Map<String, List<String>>? = null override var security: Map<String, List<String>>? = null
internal var path: Path? = null
} }
private object InstallHook : Hook<(ApplicationCallPipeline) -> Unit> { private object InstallHook : Hook<(ApplicationCallPipeline) -> Unit> {
@ -44,69 +44,53 @@ object NotarizedRoute {
name = "NotarizedRoute", name = "NotarizedRoute",
createConfiguration = ::Config createConfiguration = ::Config
) { ) {
// This is required in order to introspect the route path and authentication // This is required in order to introspect the route path and authentication
on(InstallHook) { on(InstallHook) {
val route = it as? Route ?: return@on val route = it as? Route ?: return@on
val spec = application.attributes[KompendiumAttributes.openApiSpec] val spec = application.attributes[KompendiumAttributes.openApiSpec]
val routePath = route.calculateRoutePath() val routePath = route.calculateRoutePath()
val authMethods = route.collectAuthMethods() val authMethods = route.collectAuthMethods()
pluginConfig.path?.addDefaultAuthMethods(authMethods)
require(spec.paths[routePath] == null) { addToSpec(spec, routePath, authMethods)
"""
The specified path ${Parameter.Location.path} has already been documented!
Please make sure that all notarized paths are unique
""".trimIndent()
} }
spec.paths[routePath] = pluginConfig.path
?: error("This indicates a bug in Kompendium. Please file a GitHub issue!")
} }
val spec = application.attributes[KompendiumAttributes.openApiSpec] 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] val serializableReader = application.attributes[KompendiumAttributes.schemaConfigurator]
val path = Path() pluginConfig.get?.addToSpec(path, spec, pluginConfig, serializableReader, fullPath, authMethods)
path.parameters = pluginConfig.parameters 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)
pluginConfig.get?.addToSpec(path, spec, pluginConfig, serializableReader) spec.paths[fullPath] = path
pluginConfig.delete?.addToSpec(path, spec, pluginConfig, serializableReader)
pluginConfig.head?.addToSpec(path, spec, pluginConfig, serializableReader)
pluginConfig.options?.addToSpec(path, spec, pluginConfig, serializableReader)
pluginConfig.post?.addToSpec(path, spec, pluginConfig, serializableReader)
pluginConfig.put?.addToSpec(path, spec, pluginConfig, serializableReader)
pluginConfig.patch?.addToSpec(path, spec, pluginConfig, serializableReader)
pluginConfig.path = path
} }
private fun Route.calculateRoutePath() = toString().replace(Regex("/\\(.+\\)"), "") fun Route.calculateRoutePath() = toString()
private fun Route.collectAuthMethods() = 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("/") .split("/")
.filter { it.contains(Regex("\\(authenticate .*\\)")) } .filter { it.contains(Regex("\\(authenticate .*\\)")) }
.map { it.replace("(authenticate ", "").replace(")", "") } .map { it.replace("(authenticate ", "").replace(")", "") }
.map { it.split(", ") } .map { it.split(", ") }
.flatten() .flatten()
private fun Path.addDefaultAuthMethods(methods: List<String>) {
get?.addDefaultAuthMethods(methods)
put?.addDefaultAuthMethods(methods)
post?.addDefaultAuthMethods(methods)
delete?.addDefaultAuthMethods(methods)
options?.addDefaultAuthMethods(methods)
head?.addDefaultAuthMethods(methods)
patch?.addDefaultAuthMethods(methods)
trace?.addDefaultAuthMethods(methods)
}
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()))
}
}
}
}
} }

View File

@ -10,11 +10,14 @@ import io.bkbn.kompendium.core.metadata.PatchInfo
import io.bkbn.kompendium.core.metadata.PostInfo import io.bkbn.kompendium.core.metadata.PostInfo
import io.bkbn.kompendium.core.metadata.PutInfo import io.bkbn.kompendium.core.metadata.PutInfo
import io.bkbn.kompendium.core.metadata.ResponseInfo import io.bkbn.kompendium.core.metadata.ResponseInfo
import io.bkbn.kompendium.enrichment.TypeEnrichment
import io.bkbn.kompendium.json.schema.SchemaConfigurator import io.bkbn.kompendium.json.schema.SchemaConfigurator
import io.bkbn.kompendium.json.schema.SchemaGenerator 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.definition.ReferenceDefinition
import io.bkbn.kompendium.json.schema.util.Helpers.getReferenceSlug import io.bkbn.kompendium.json.schema.util.Helpers.getReferenceSlug
import io.bkbn.kompendium.json.schema.util.Helpers.getSimpleSlug import io.bkbn.kompendium.json.schema.util.Helpers.getSlug
import io.bkbn.kompendium.oas.OpenApiSpec import io.bkbn.kompendium.oas.OpenApiSpec
import io.bkbn.kompendium.oas.path.Path import io.bkbn.kompendium.oas.path.Path
import io.bkbn.kompendium.oas.path.PathOperation import io.bkbn.kompendium.oas.path.PathOperation
@ -22,32 +25,60 @@ import io.bkbn.kompendium.oas.payload.MediaType
import io.bkbn.kompendium.oas.payload.Request import io.bkbn.kompendium.oas.payload.Request
import io.bkbn.kompendium.oas.payload.Response import io.bkbn.kompendium.oas.payload.Response
import kotlin.reflect.KClass import kotlin.reflect.KClass
import kotlin.reflect.KMutableProperty1
import kotlin.reflect.KType import kotlin.reflect.KType
object Helpers { object Helpers {
fun MethodInfo.addToSpec(path: Path, spec: OpenApiSpec, config: SpecConfig, schemaConfigurator: SchemaConfigurator) { 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( SchemaGenerator.fromTypeOrUnit(
this.response.responseType, type = this.response.responseType,
spec.components.schemas, schemaConfigurator cache = spec.components.schemas,
schemaConfigurator = schemaConfigurator,
enrichment = this.response.typeEnrichment,
)?.let { schema -> )?.let { schema ->
spec.components.schemas[this.response.responseType.getSimpleSlug()] = schema spec.components.schemas[this.response.responseType.getSlug(this.response.typeEnrichment)] = schema
} }
errors.forEach { error -> errors.forEach { error ->
SchemaGenerator.fromTypeOrUnit(error.responseType, spec.components.schemas, schemaConfigurator)?.let { schema -> SchemaGenerator.fromTypeOrUnit(
spec.components.schemas[error.responseType.getSimpleSlug()] = schema type = error.responseType,
cache = spec.components.schemas,
schemaConfigurator = schemaConfigurator,
enrichment = error.typeEnrichment,
)?.let { schema ->
spec.components.schemas[error.responseType.getSlug(error.typeEnrichment)] = schema
} }
} }
when (this) { when (this) {
is MethodInfoWithRequest -> { is MethodInfoWithRequest -> {
SchemaGenerator.fromTypeOrUnit( SchemaGenerator.fromTypeOrUnit(
this.request.requestType, type = this.request.requestType,
spec.components.schemas, cache = spec.components.schemas,
schemaConfigurator schemaConfigurator = schemaConfigurator,
enrichment = this.request.typeEnrichment,
)?.let { schema -> )?.let { schema ->
spec.components.schemas[this.request.requestType.getSimpleSlug()] = schema spec.components.schemas[this.request.requestType.getSlug(this.request.typeEnrichment)] = schema
} }
} }
@ -55,15 +86,25 @@ object Helpers {
} }
val operations = this.toPathOperation(config) val operations = this.toPathOperation(config)
operations.addDefaultAuthMethods(authMethods)
when (this) { fun setOperation(
is DeleteInfo -> path.delete = operations property: KMutableProperty1<Path, PathOperation?>
is GetInfo -> path.get = operations ) {
is HeadInfo -> path.head = operations require(property.get(path) == null) {
is PatchInfo -> path.patch = operations "A route has already been registered for path: $routePath and method: ${property.name.uppercase()}"
is PostInfo -> path.post = operations }
is PutInfo -> path.put = operations property.set(path, operations)
is OptionsInfo -> path.options = 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)
} }
} }
@ -82,7 +123,11 @@ object Helpers {
requestBody = when (this) { requestBody = when (this) {
is MethodInfoWithRequest -> Request( is MethodInfoWithRequest -> Request(
description = this.request.description, description = this.request.description,
content = this.request.requestType.toReferenceContent(this.request.examples), content = this.request.requestType.toReferenceContent(
examples = this.request.examples,
mediaTypes = this.request.mediaTypes,
enrichment = this.request.typeEnrichment
),
required = true required = true
) )
@ -91,7 +136,11 @@ object Helpers {
responses = mapOf( responses = mapOf(
this.response.responseCode.value to Response( this.response.responseCode.value to Response(
description = this.response.description, description = this.response.description,
content = this.response.responseType.toReferenceContent(this.response.examples) content = this.response.responseType.toReferenceContent(
examples = this.response.examples,
mediaTypes = this.response.mediaTypes,
enrichment = this.response.typeEnrichment
)
) )
).plus(this.errors.toResponseMap()) ).plus(this.errors.toResponseMap())
) )
@ -99,18 +148,33 @@ object Helpers {
private fun List<ResponseInfo>.toResponseMap(): Map<Int, Response> = associate { error -> private fun List<ResponseInfo>.toResponseMap(): Map<Int, Response> = associate { error ->
error.responseCode.value to Response( error.responseCode.value to Response(
description = error.description, description = error.description,
content = error.responseType.toReferenceContent(error.examples) content = error.responseType.toReferenceContent(
examples = error.examples,
mediaTypes = error.mediaTypes,
enrichment = error.typeEnrichment
)
) )
} }
private fun KType.toReferenceContent(examples: Map<String, MediaType.Example>?): Map<String, MediaType>? = private fun KType.toReferenceContent(
examples: Map<String, MediaType.Example>?,
mediaTypes: Set<String>,
enrichment: TypeEnrichment<*>?
): Map<String, MediaType>? =
when (this.classifier as KClass<*>) { when (this.classifier as KClass<*>) {
Unit::class -> null Unit::class -> null
else -> mapOf( else -> mediaTypes.associateWith {
"application/json" to MediaType( MediaType(
schema = ReferenceDefinition(this.getReferenceSlug()), schema = if (this.isMarkedNullable) {
OneOfDefinition(
NullableDefinition(),
ReferenceDefinition(this.getReferenceSlug(enrichment))
)
} else {
ReferenceDefinition(this.getReferenceSlug(enrichment))
},
examples = examples examples = examples
) )
) }
} }
} }

View File

@ -2,56 +2,64 @@ package io.bkbn.kompendium.core
import dev.forst.ktor.apikey.apiKey import dev.forst.ktor.apikey.apiKey
import io.bkbn.kompendium.core.fixtures.TestHelpers.openApiTestAllSerializers import io.bkbn.kompendium.core.fixtures.TestHelpers.openApiTestAllSerializers
import io.bkbn.kompendium.core.util.TestModules.complexRequest import io.bkbn.kompendium.core.util.complexRequest
import io.bkbn.kompendium.core.util.TestModules.customAuthConfig import io.bkbn.kompendium.core.util.customAuthConfig
import io.bkbn.kompendium.core.util.TestModules.customFieldNameResponse import io.bkbn.kompendium.core.util.customFieldNameResponse
import io.bkbn.kompendium.core.util.TestModules.dateTimeString import io.bkbn.kompendium.core.util.dateTimeString
import io.bkbn.kompendium.core.util.TestModules.defaultAuthConfig import io.bkbn.kompendium.core.util.defaultAuthConfig
import io.bkbn.kompendium.core.util.TestModules.defaultField import io.bkbn.kompendium.core.util.defaultField
import io.bkbn.kompendium.core.util.TestModules.defaultParameter import io.bkbn.kompendium.core.util.defaultParameter
import io.bkbn.kompendium.core.util.TestModules.exampleParams import io.bkbn.kompendium.core.util.enrichedComplexGenericType
import io.bkbn.kompendium.core.util.TestModules.genericException import io.bkbn.kompendium.core.util.enrichedNestedCollection
import io.bkbn.kompendium.core.util.TestModules.genericPolymorphicResponse import io.bkbn.kompendium.core.util.enrichedSimpleRequest
import io.bkbn.kompendium.core.util.TestModules.genericPolymorphicResponseMultipleImpls import io.bkbn.kompendium.core.util.enrichedSimpleResponse
import io.bkbn.kompendium.core.util.TestModules.gnarlyGenericResponse import io.bkbn.kompendium.core.util.exampleParams
import io.bkbn.kompendium.core.util.TestModules.headerParameter import io.bkbn.kompendium.core.util.genericException
import io.bkbn.kompendium.core.util.TestModules.ignoredFieldsResponse import io.bkbn.kompendium.core.util.genericPolymorphicResponse
import io.bkbn.kompendium.core.util.TestModules.multipleAuthStrategies import io.bkbn.kompendium.core.util.genericPolymorphicResponseMultipleImpls
import io.bkbn.kompendium.core.util.TestModules.multipleExceptions import io.bkbn.kompendium.core.util.gnarlyGenericResponse
import io.bkbn.kompendium.core.util.TestModules.nestedGenericCollection import io.bkbn.kompendium.core.util.headerParameter
import io.bkbn.kompendium.core.util.TestModules.nestedGenericMultipleParamsCollection import io.bkbn.kompendium.core.util.ignoredFieldsResponse
import io.bkbn.kompendium.core.util.TestModules.nestedGenericResponse import io.bkbn.kompendium.core.util.multipleAuthStrategies
import io.bkbn.kompendium.core.util.TestModules.nestedTypeName import io.bkbn.kompendium.core.util.multipleExceptions
import io.bkbn.kompendium.core.util.TestModules.nestedUnderRoot import io.bkbn.kompendium.core.util.nestedGenericCollection
import io.bkbn.kompendium.core.util.TestModules.nonRequiredParam import io.bkbn.kompendium.core.util.nestedGenericMultipleParamsCollection
import io.bkbn.kompendium.core.util.TestModules.nonRequiredParams import io.bkbn.kompendium.core.util.nestedGenericResponse
import io.bkbn.kompendium.core.util.TestModules.notarizedDelete import io.bkbn.kompendium.core.util.nestedTypeName
import io.bkbn.kompendium.core.util.TestModules.notarizedGet import io.bkbn.kompendium.core.util.nestedUnderRoot
import io.bkbn.kompendium.core.util.TestModules.notarizedHead import io.bkbn.kompendium.core.util.nonRequiredParam
import io.bkbn.kompendium.core.util.TestModules.notarizedOptions import io.bkbn.kompendium.core.util.nonRequiredParams
import io.bkbn.kompendium.core.util.TestModules.notarizedPatch import io.bkbn.kompendium.core.util.notarizedDelete
import io.bkbn.kompendium.core.util.TestModules.notarizedPost import io.bkbn.kompendium.core.util.notarizedGet
import io.bkbn.kompendium.core.util.TestModules.notarizedPut import io.bkbn.kompendium.core.util.notarizedHead
import io.bkbn.kompendium.core.util.TestModules.nullableEnumField import io.bkbn.kompendium.core.util.notarizedOptions
import io.bkbn.kompendium.core.util.TestModules.nullableField import io.bkbn.kompendium.core.util.notarizedPatch
import io.bkbn.kompendium.core.util.TestModules.nullableNestedObject import io.bkbn.kompendium.core.util.notarizedPost
import io.bkbn.kompendium.core.util.TestModules.nullableReference import io.bkbn.kompendium.core.util.notarizedPut
import io.bkbn.kompendium.core.util.TestModules.polymorphicCollectionResponse import io.bkbn.kompendium.core.util.nullableEnumField
import io.bkbn.kompendium.core.util.TestModules.polymorphicException import io.bkbn.kompendium.core.util.nullableField
import io.bkbn.kompendium.core.util.TestModules.polymorphicMapResponse import io.bkbn.kompendium.core.util.nullableNestedObject
import io.bkbn.kompendium.core.util.TestModules.polymorphicResponse import io.bkbn.kompendium.core.util.nullableReference
import io.bkbn.kompendium.core.util.TestModules.primitives import io.bkbn.kompendium.core.util.overrideMediaTypes
import io.bkbn.kompendium.core.util.TestModules.reqRespExamples import io.bkbn.kompendium.core.util.polymorphicCollectionResponse
import io.bkbn.kompendium.core.util.TestModules.requiredParams import io.bkbn.kompendium.core.util.polymorphicException
import io.bkbn.kompendium.core.util.TestModules.returnsList import io.bkbn.kompendium.core.util.polymorphicMapResponse
import io.bkbn.kompendium.core.util.TestModules.rootRoute import io.bkbn.kompendium.core.util.polymorphicResponse
import io.bkbn.kompendium.core.util.TestModules.simpleGenericResponse import io.bkbn.kompendium.core.util.primitives
import io.bkbn.kompendium.core.util.TestModules.simplePathParsing import io.bkbn.kompendium.core.util.reqRespExamples
import io.bkbn.kompendium.core.util.TestModules.simpleRecursive import io.bkbn.kompendium.core.util.requiredParams
import io.bkbn.kompendium.core.util.TestModules.singleException import io.bkbn.kompendium.core.util.returnsList
import io.bkbn.kompendium.core.util.TestModules.trailingSlash import io.bkbn.kompendium.core.util.rootRoute
import io.bkbn.kompendium.core.util.TestModules.unbackedFieldsResponse import io.bkbn.kompendium.core.util.samePathDifferentMethodsAndAuth
import io.bkbn.kompendium.core.util.TestModules.withOperationId 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.definition.TypeDefinition
import io.bkbn.kompendium.json.schema.exception.UnknownSchemaException import io.bkbn.kompendium.json.schema.exception.UnknownSchemaException
import io.bkbn.kompendium.oas.component.Components import io.bkbn.kompendium.oas.component.Components
@ -73,8 +81,9 @@ import io.ktor.server.auth.UserIdPrincipal
import io.ktor.server.auth.basic import io.ktor.server.auth.basic
import io.ktor.server.auth.jwt.jwt import io.ktor.server.auth.jwt.jwt
import io.ktor.server.auth.oauth import io.ktor.server.auth.oauth
import kotlin.reflect.typeOf import java.net.URI
import java.time.Instant import java.time.Instant
import kotlin.reflect.typeOf
class KompendiumTest : DescribeSpec({ class KompendiumTest : DescribeSpec({
describe("Notarized Open API Metadata Tests") { describe("Notarized Open API Metadata Tests") {
@ -111,6 +120,9 @@ class KompendiumTest : DescribeSpec({
it("Can notarize a route with non-required params") { it("Can notarize a route with non-required params") {
openApiTestAllSerializers("T0011__non_required_params.json") { nonRequiredParams() } openApiTestAllSerializers("T0011__non_required_params.json") { nonRequiredParams() }
} }
it("Can override media types") {
openApiTestAllSerializers("T0052__override_media_types.json") { overrideMediaTypes() }
}
} }
describe("Route Parsing") { describe("Route Parsing") {
it("Can parse a simple path and store it under the expected route") { it("Can parse a simple path and store it under the expected route") {
@ -243,12 +255,68 @@ class KompendiumTest : DescribeSpec({
it("Can handle nested type names") { it("Can handle nested type names") {
openApiTestAllSerializers("T0044__nested_type_name.json") { nestedTypeName() } 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") { describe("Error Handling") {
it("Throws a clear exception when an unidentified type is encountered") { it("Throws a clear exception when an unidentified type is encountered") {
val exception = shouldThrow<UnknownSchemaException> { openApiTestAllSerializers("") { dateTimeString() } } val exception = shouldThrow<UnknownSchemaException> { openApiTestAllSerializers("") { dateTimeString() } }
exception.message should startWith("An unknown type was encountered: class java.time.Instant") 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(
snapshotName = "",
applicationSetup = {
install(Authentication) {
basic("basic") {
realm = "Ktor Server"
validate { UserIdPrincipal("Placeholder") }
}
}
},
) {
samePathSameMethod()
}
}
exception.message should startWith("A route has already been registered for path: /test/{a} and method: GET")
}
} }
describe("Constraints") { describe("Constraints") {
// TODO Assess strategies here // TODO Assess strategies here
@ -360,4 +428,18 @@ class KompendiumTest : DescribeSpec({
) { multipleAuthStrategies() } ) { multipleAuthStrategies() }
} }
} }
describe("Enrichment") {
it("Can enrich a simple request") {
openApiTestAllSerializers("T0055__enriched_simple_request.json") { enrichedSimpleRequest() }
}
it("Can enrich a simple response") {
openApiTestAllSerializers("T0058__enriched_simple_response.json") { enrichedSimpleResponse() }
}
it("Can enrich a nested collection") {
openApiTestAllSerializers("T0056__enriched_nested_collection.json") { enrichedNestedCollection() }
}
it("Can enrich a complex generic type") {
openApiTestAllSerializers("T0057__enriched_complex_generic_type.json") { enrichedComplexGenericType() }
}
}
}) })

View File

@ -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>()
}
}
}

View File

@ -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>()

View File

@ -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")
)
)
)

View File

@ -0,0 +1,137 @@
package io.bkbn.kompendium.core.util
import io.bkbn.kompendium.core.fixtures.ComplexRequest
import io.bkbn.kompendium.core.fixtures.MultiNestedGenerics
import io.bkbn.kompendium.core.fixtures.NestedComplexItem
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.PostInfo
import io.bkbn.kompendium.core.plugin.NotarizedRoute
import io.bkbn.kompendium.enrichment.TypeEnrichment
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.enrichedSimpleResponse() {
route("/enriched") {
install(NotarizedRoute()) {
get = GetInfo.builder {
summary(TestModules.defaultPathSummary)
description(TestModules.defaultPathDescription)
response {
responseType(
enrichment = TypeEnrichment("simple") {
TestResponse::c {
description = "A simple description"
}
}
)
description("A good response")
responseCode(HttpStatusCode.Created)
}
}
}
}
}
fun Routing.enrichedSimpleRequest() {
route("/example") {
install(NotarizedRoute()) {
parameters = TestModules.defaultParams
post = PostInfo.builder {
summary(TestModules.defaultPathSummary)
description(TestModules.defaultPathDescription)
request {
requestType(
enrichment = TypeEnrichment("simple") {
TestSimpleRequest::a {
description = "A simple description"
}
TestSimpleRequest::b {
deprecated = true
}
}
)
description("A test request")
}
response {
responseCode(HttpStatusCode.Created)
responseType<TestCreatedResponse>()
description(TestModules.defaultResponseDescription)
}
}
}
}
}
fun Routing.enrichedNestedCollection() {
route("/example") {
install(NotarizedRoute()) {
parameters = TestModules.defaultParams
post = PostInfo.builder {
summary(TestModules.defaultPathSummary)
description(TestModules.defaultPathDescription)
request {
requestType(
enrichment = TypeEnrichment("simple") {
ComplexRequest::tables {
description = "A nested item"
typeEnrichment = TypeEnrichment("nested") {
NestedComplexItem::name {
description = "A nested description"
}
}
}
}
)
description("A test request")
}
response {
responseCode(HttpStatusCode.Created)
responseType<TestCreatedResponse>()
description(TestModules.defaultResponseDescription)
}
}
}
}
}
fun Routing.enrichedComplexGenericType() {
route("/example") {
install(NotarizedRoute()) {
parameters = TestModules.defaultParams
post = PostInfo.builder {
summary(TestModules.defaultPathSummary)
description(TestModules.defaultPathDescription)
request {
requestType(
enrichment = TypeEnrichment("simple") {
MultiNestedGenerics<String, ComplexRequest>::content {
description = "Getting pretty crazy"
typeEnrichment = TypeEnrichment("nested") {
ComplexRequest::tables {
description = "A nested item"
typeEnrichment = TypeEnrichment("nested") {
NestedComplexItem::name {
description = "A nested description"
}
}
}
}
}
}
)
description("A test request")
}
response {
responseCode(HttpStatusCode.Created)
responseType<TestCreatedResponse>()
description(TestModules.defaultResponseDescription)
}
}
}
}
}

View File

@ -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("basic") {
basicGetGenerator<TestResponse>()
}
}
}

View File

@ -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")
)
)
)
)

View File

@ -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>>()
}
}
}
}
}

View File

@ -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>()
}
}
}
}
}
}

View File

@ -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)
}
}
}
}
}

View File

@ -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>>()

View File

@ -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>()

View File

@ -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>()
}
}
}
}
}
}

View File

@ -1,66 +1,29 @@
package io.bkbn.kompendium.core.util package io.bkbn.kompendium.core.util
import io.bkbn.kompendium.core.fixtures.Barzo
import io.bkbn.kompendium.core.fixtures.ColumnSchema
import io.bkbn.kompendium.core.fixtures.ComplexRequest
import io.bkbn.kompendium.core.fixtures.DateTimeString
import io.bkbn.kompendium.core.fixtures.DefaultField
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.Foosy
import io.bkbn.kompendium.core.fixtures.Gibbity
import io.bkbn.kompendium.core.fixtures.ManyThings
import io.bkbn.kompendium.core.fixtures.MultiNestedGenerics
import io.bkbn.kompendium.core.fixtures.Nested
import io.bkbn.kompendium.core.fixtures.NullableEnum
import io.bkbn.kompendium.core.fixtures.NullableField
import io.bkbn.kompendium.core.fixtures.Page
import io.bkbn.kompendium.core.fixtures.ProfileUpdateRequest
import io.bkbn.kompendium.core.fixtures.SerialNameObject
import io.bkbn.kompendium.core.fixtures.TestCreatedResponse
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.fixtures.TestSimpleRequest
import io.bkbn.kompendium.core.fixtures.TransientObject
import io.bkbn.kompendium.core.fixtures.UnbakcedObject
import io.bkbn.kompendium.core.metadata.DeleteInfo
import io.bkbn.kompendium.core.metadata.GetInfo 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.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.json.schema.definition.TypeDefinition
import io.bkbn.kompendium.oas.payload.Parameter import io.bkbn.kompendium.oas.payload.Parameter
import io.ktor.http.HttpStatusCode import io.ktor.http.HttpStatusCode
import io.ktor.server.application.call
import io.ktor.server.application.install import io.ktor.server.application.install
import io.ktor.server.auth.authenticate
import io.ktor.server.response.respond
import io.ktor.server.response.respondText
import io.ktor.server.routing.Route import io.ktor.server.routing.Route
import io.ktor.server.routing.Routing 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 import io.ktor.server.routing.route
object TestModules { object TestModules {
private const val defaultPath = "/test/{a}"
private const val rootPath = "/"
private const val defaultResponseDescription = "A Successful Endeavor"
private const val defaultRequestDescription = "You gotta send it"
private const val defaultPathSummary = "Great Summary!"
private const val defaultPathDescription = "testing more"
private val defaultParams = listOf( 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( Parameter(
name = "a", name = "a",
`in` = Parameter.Location.path, `in` = Parameter.Location.path,
@ -72,599 +35,21 @@ object TestModules {
schema = TypeDefinition.INT schema = TypeDefinition.INT
) )
) )
}
fun Routing.notarizedGet() { internal inline fun <reified T> Routing.basicGetGenerator(
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.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>()
}
}
}
}
}
}
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>>()
}
}
}
}
}
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")
)
)
)
)
fun Routing.defaultParameter() = basicGetGenerator<TestResponse>(
params = listOf(
Parameter(
name = "id",
`in` = Parameter.Location.path,
schema = TypeDefinition.STRING.withDefault("IDK")
)
)
)
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>()
fun Routing.polymorphicResponse() = basicGetGenerator<FlibbityGibbit>()
fun Routing.ignoredFieldsResponse() = basicGetGenerator<TransientObject>()
fun Routing.unbackedFieldsResponse() = basicGetGenerator<UnbakcedObject>()
fun Routing.customFieldNameResponse() = basicGetGenerator<SerialNameObject>()
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>>()
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.simpleRecursive() = basicGetGenerator<ColumnSchema>()
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>()
}
}
}
private inline fun <reified T> Routing.basicGetGenerator(
params: List<Parameter> = emptyList(), params: List<Parameter> = emptyList(),
operationId: String? = null operationId: String? = null
) { ) {
route(rootPath) { route(rootPath) {
basicGetGenerator<T>(params, operationId) basicGetGenerator<T>(params, operationId)
} }
} }
private inline fun <reified T> Route.basicGetGenerator( internal inline fun <reified T> Route.basicGetGenerator(
params: List<Parameter> = emptyList(), params: List<Parameter> = emptyList(),
operationId: String? = null operationId: String? = null
) { ) {
install(NotarizedRoute()) { install(NotarizedRoute()) {
get = GetInfo.builder { get = GetInfo.builder {
summary(defaultPathSummary) summary(defaultPathSummary)
@ -678,5 +63,4 @@ object TestModules {
} }
} }
} }
}
} }

View File

@ -124,15 +124,19 @@
"type": "object", "type": "object",
"properties": { "properties": {
"enumeration": { "enumeration": {
"enum": [ "$ref": "#/components/schemas/SimpleEnum"
"ONE",
"TWO"
]
} }
}, },
"required": [ "required": [
"enumeration" "enumeration"
] ]
},
"SimpleEnum": {
"type": "string",
"enum": [
"ONE",
"TWO"
]
} }
}, },
"securitySchemes": {} "securitySchemes": {}

View File

@ -91,11 +91,6 @@
"required": [] "required": []
}, },
"ProfileMetadataUpdateRequest": { "ProfileMetadataUpdateRequest": {
"oneOf": [
{
"type": "null"
},
{
"type": "object", "type": "object",
"properties": { "properties": {
"isPrivate": { "isPrivate": {
@ -121,8 +116,6 @@
}, },
"required": [] "required": []
} }
]
}
}, },
"securitySchemes": {} "securitySchemes": {}
}, },

View File

@ -62,15 +62,20 @@
"type": "null" "type": "null"
}, },
{ {
"enum": [ "$ref": "#/components/schemas/TestEnum"
"YES",
"NO"
]
} }
] ]
} }
}, },
"required": [] "required": []
},
"TestEnum":
{
"type": "string",
"enum": [
"YES",
"NO"
]
} }
}, },
"securitySchemes": {} "securitySchemes": {}

View File

@ -57,10 +57,7 @@
"type": "object", "type": "object",
"properties": { "properties": {
"enumeration": { "enumeration": {
"enum": [ "$ref": "#/components/schemas/SimpleEnum"
"ONE",
"TWO"
]
} }
}, },
"required": [ "required": [
@ -120,6 +117,13 @@
"required": [ "required": [
"content" "content"
] ]
},
"SimpleEnum": {
"type": "string",
"enum": [
"ONE",
"TWO"
]
} }
}, },
"securitySchemes": {} "securitySchemes": {}

View File

@ -53,6 +53,14 @@
"webhooks": {}, "webhooks": {},
"components": { "components": {
"schemas": { "schemas": {
"ColumnMode": {
"type": "string",
"enum": [
"NULLABLE",
"REQUIRED",
"REPEATED"
]
},
"ColumnSchema": { "ColumnSchema": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -60,11 +68,7 @@
"type": "string" "type": "string"
}, },
"mode": { "mode": {
"enum": [ "$ref": "#/components/schemas/ColumnMode"
"NULLABLE",
"REQUIRED",
"REPEATED"
]
}, },
"name": { "name": {
"type": "string" "type": "string"

View File

@ -39,7 +39,7 @@
"content": { "content": {
"application/json": { "application/json": {
"schema": { "schema": {
"$ref": "#/components/schemas/UnbakcedObject" "$ref": "#/components/schemas/UnbackedObject"
} }
} }
} }
@ -53,7 +53,7 @@
"webhooks": {}, "webhooks": {},
"components": { "components": {
"schemas": { "schemas": {
"UnbakcedObject": { "UnbackedObject": {
"type": "object", "type": "object",
"properties": { "properties": {
"backed": { "backed": {

View File

@ -0,0 +1,79 @@
{
"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": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/TestResponse"
}
]
}
}
}
}
},
"deprecated": false
},
"parameters": []
}
},
"webhooks": {},
"components": {
"schemas": {
"TestResponse": {
"type": "object",
"properties": {
"c": {
"type": "string"
}
},
"required": [
"c"
]
}
},
"securitySchemes": {}
},
"security": [],
"tags": []
}

View File

@ -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": []
}

View File

@ -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": []
}

View File

@ -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": []
}

View File

@ -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": {
"/example": {
"post": {
"tags": [],
"summary": "Great Summary!",
"description": "testing more",
"parameters": [],
"requestBody": {
"description": "A test request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TestSimpleRequest-simple"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "A Successful Endeavor",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TestCreatedResponse"
}
}
}
}
},
"deprecated": false
},
"parameters": [
{
"name": "a",
"in": "path",
"schema": {
"type": "string"
},
"required": true,
"deprecated": false
},
{
"name": "aa",
"in": "query",
"schema": {
"type": "number",
"format": "int32"
},
"required": true,
"deprecated": false
}
]
}
},
"webhooks": {},
"components": {
"schemas": {
"TestCreatedResponse": {
"type": "object",
"properties": {
"c": {
"type": "string"
},
"id": {
"type": "number",
"format": "int32"
}
},
"required": [
"c",
"id"
]
},
"TestSimpleRequest-simple": {
"type": "object",
"properties": {
"a": {
"type": "string",
"description": "A simple description"
},
"b": {
"type": "number",
"format": "int32",
"deprecated": true
}
},
"required": [
"a",
"b"
]
}
},
"securitySchemes": {}
},
"security": [],
"tags": []
}

View File

@ -0,0 +1,168 @@
{
"openapi": "3.1.0",
"jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
"info": {
"title": "Test API",
"version": "1.33.7",
"description": "An amazing, fully-ish 😉 generated API spec",
"termsOfService": "https://example.com",
"contact": {
"name": "Homer Simpson",
"url": "https://gph.is/1NPUDiM",
"email": "chunkylover53@aol.com"
},
"license": {
"name": "MIT",
"url": "https://github.com/bkbnio/kompendium/blob/main/LICENSE"
}
},
"servers": [
{
"url": "https://myawesomeapi.com",
"description": "Production instance of my API"
},
{
"url": "https://staging.myawesomeapi.com",
"description": "Where the fun stuff happens"
}
],
"paths": {
"/example": {
"post": {
"tags": [],
"summary": "Great Summary!",
"description": "testing more",
"parameters": [],
"requestBody": {
"description": "A test request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComplexRequest-simple"
}
}
},
"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"
]
},
"ComplexRequest-simple": {
"type": "object",
"properties": {
"amazingField": {
"type": "string"
},
"org": {
"type": "string"
},
"tables": {
"items": {
"$ref": "#/components/schemas/NestedComplexItem-nested"
},
"description": "A nested item",
"type": "array"
}
},
"required": [
"amazingField",
"org",
"tables"
]
},
"NestedComplexItem-nested": {
"type": "object",
"properties": {
"alias": {
"additionalProperties": {
"$ref": "#/components/schemas/CrazyItem"
},
"type": "object"
},
"name": {
"type": "string",
"description": "A nested description"
}
},
"required": [
"alias",
"name"
]
},
"CrazyItem": {
"type": "object",
"properties": {
"enumeration": {
"$ref": "#/components/schemas/SimpleEnum"
}
},
"required": [
"enumeration"
]
},
"SimpleEnum": {
"type": "string",
"enum": [
"ONE",
"TWO"
]
}
},
"securitySchemes": {}
},
"security": [],
"tags": []
}

View File

@ -0,0 +1,183 @@
{
"openapi": "3.1.0",
"jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
"info": {
"title": "Test API",
"version": "1.33.7",
"description": "An amazing, fully-ish 😉 generated API spec",
"termsOfService": "https://example.com",
"contact": {
"name": "Homer Simpson",
"url": "https://gph.is/1NPUDiM",
"email": "chunkylover53@aol.com"
},
"license": {
"name": "MIT",
"url": "https://github.com/bkbnio/kompendium/blob/main/LICENSE"
}
},
"servers": [
{
"url": "https://myawesomeapi.com",
"description": "Production instance of my API"
},
{
"url": "https://staging.myawesomeapi.com",
"description": "Where the fun stuff happens"
}
],
"paths": {
"/example": {
"post": {
"tags": [],
"summary": "Great Summary!",
"description": "testing more",
"parameters": [],
"requestBody": {
"description": "A test request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MultiNestedGenerics-String-ComplexRequest-simple"
}
}
},
"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"
]
},
"MultiNestedGenerics-String-ComplexRequest-simple": {
"type": "object",
"properties": {
"content": {
"additionalProperties": {
"$ref": "#/components/schemas/ComplexRequest-nested"
},
"description": "Getting pretty crazy",
"type": "object"
}
},
"required": [
"content"
]
},
"ComplexRequest-nested": {
"type": "object",
"properties": {
"amazingField": {
"type": "string"
},
"org": {
"type": "string"
},
"tables": {
"items": {
"$ref": "#/components/schemas/NestedComplexItem-nested"
},
"description": "A nested item",
"type": "array"
}
},
"required": [
"amazingField",
"org",
"tables"
]
},
"NestedComplexItem-nested": {
"type": "object",
"properties": {
"alias": {
"additionalProperties": {
"$ref": "#/components/schemas/CrazyItem"
},
"type": "object"
},
"name": {
"type": "string",
"description": "A nested description"
}
},
"required": [
"alias",
"name"
]
},
"CrazyItem": {
"type": "object",
"properties": {
"enumeration": {
"$ref": "#/components/schemas/SimpleEnum"
}
},
"required": [
"enumeration"
]
},
"SimpleEnum": {
"type": "string",
"enum": [
"ONE",
"TWO"
]
}
},
"securitySchemes": {}
},
"security": [],
"tags": []
}

View File

@ -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": {
"/enriched": {
"get": {
"tags": [],
"summary": "Great Summary!",
"description": "testing more",
"parameters": [],
"responses": {
"201": {
"description": "A good response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TestResponse-simple"
}
}
}
}
},
"deprecated": false
},
"parameters": []
}
},
"webhooks": {},
"components": {
"schemas": {
"TestResponse-simple": {
"type": "object",
"properties": {
"c": {
"type": "string",
"description": "A simple description"
}
},
"required": [
"c"
]
}
},
"securitySchemes": {}
},
"security": [],
"tags": []
}

View File

@ -21,13 +21,14 @@ import io.ktor.serialization.gson.gson
import io.ktor.serialization.jackson.jackson import io.ktor.serialization.jackson.jackson
import io.ktor.serialization.kotlinx.json.json import io.ktor.serialization.kotlinx.json.json
import io.ktor.server.application.Application import io.ktor.server.application.Application
import io.ktor.server.engine.ApplicationEngineEnvironmentBuilder
import io.ktor.server.plugins.contentnegotiation.ContentNegotiation import io.ktor.server.plugins.contentnegotiation.ContentNegotiation
import io.ktor.server.routing.Routing import io.ktor.server.routing.Routing
import io.ktor.server.testing.ApplicationTestBuilder import io.ktor.server.testing.ApplicationTestBuilder
import io.ktor.server.testing.testApplication import io.ktor.server.testing.testApplication
import kotlin.reflect.KType
import kotlinx.serialization.json.Json
import java.io.File import java.io.File
import kotlinx.serialization.json.Json
import kotlin.reflect.KType
object TestHelpers { object TestHelpers {
private const val OPEN_API_ENDPOINT = "/openapi.json" private const val OPEN_API_ENDPOINT = "/openapi.json"
@ -43,8 +44,8 @@ object TestHelpers {
* exists as expected, and that the content matches the expected blob found in the specified file * 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 * @param snapshotName The snapshot file to retrieve from the resources folder
*/ */
private suspend fun ApplicationTestBuilder.compareOpenAPISpec(snapshotName: String) { private suspend fun ApplicationTestBuilder.compareOpenAPISpec(rootPath: String, snapshotName: String) {
val response = client.get(OPEN_API_ENDPOINT) val response = client.get("$rootPath$OPEN_API_ENDPOINT")
response shouldHaveStatus HttpStatusCode.OK response shouldHaveStatus HttpStatusCode.OK
response.bodyAsText() shouldNot beBlank() response.bodyAsText() shouldNot beBlank()
response.bodyAsText() shouldEqualJson getFileSnapshot(snapshotName) response.bodyAsText() shouldEqualJson getFileSnapshot(snapshotName)
@ -61,11 +62,36 @@ object TestHelpers {
customTypes: Map<KType, JsonSchema> = emptyMap(), customTypes: Map<KType, JsonSchema> = emptyMap(),
applicationSetup: Application.() -> Unit = { }, applicationSetup: Application.() -> Unit = { },
specOverrides: OpenApiSpec.() -> OpenApiSpec = { this }, specOverrides: OpenApiSpec.() -> OpenApiSpec = { this },
applicationEnvironmentBuilder: ApplicationEngineEnvironmentBuilder.() -> Unit = {},
routeUnderTest: Routing.() -> Unit routeUnderTest: Routing.() -> Unit
) { ) {
openApiTest(snapshotName, SupportedSerializer.KOTLINX, routeUnderTest, applicationSetup, specOverrides, customTypes) openApiTest(
openApiTest(snapshotName, SupportedSerializer.JACKSON, routeUnderTest, applicationSetup, specOverrides, customTypes) snapshotName,
openApiTest(snapshotName, SupportedSerializer.GSON, routeUnderTest, applicationSetup, specOverrides, customTypes) 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( private fun openApiTest(
@ -74,8 +100,10 @@ object TestHelpers {
routeUnderTest: Routing.() -> Unit, routeUnderTest: Routing.() -> Unit,
applicationSetup: Application.() -> Unit, applicationSetup: Application.() -> Unit,
specOverrides: OpenApiSpec.() -> OpenApiSpec, specOverrides: OpenApiSpec.() -> OpenApiSpec,
typeOverrides: Map<KType, JsonSchema> = emptyMap() typeOverrides: Map<KType, JsonSchema> = emptyMap(),
applicationBuilder: ApplicationEngineEnvironmentBuilder.() -> Unit = {}
) = testApplication { ) = testApplication {
environment(applicationBuilder)
install(NotarizedApplication()) { install(NotarizedApplication()) {
customTypes = typeOverrides customTypes = typeOverrides
spec = defaultSpec().specOverrides() spec = defaultSpec().specOverrides()
@ -105,6 +133,7 @@ object TestHelpers {
redoc() redoc()
routeUnderTest() routeUnderTest()
} }
compareOpenAPISpec(snapshotName) val root = ApplicationEngineEnvironmentBuilder().apply(applicationBuilder).rootPath
compareOpenAPISpec(root, snapshotName)
} }
} }

View File

@ -163,7 +163,7 @@ data class TransientObject(
) )
@Serializable @Serializable
data class UnbakcedObject( data class UnbackedObject(
val backed: String val backed: String
) { ) {
val unbacked: String get() = "unbacked" val unbacked: String get() = "unbacked"
@ -176,3 +176,14 @@ data class SerialNameObject(
@SerialName("snake_case_name") @SerialName("snake_case_name")
val camelCaseName: String val camelCaseName: String
) )
enum class Color {
RED,
GREEN,
BLUE
}
@Serializable
data class ObjectWithEnum(
val color: Color
)

View File

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

7
docs/helpers/index.md Normal file
View File

@ -0,0 +1,7 @@
Helper modules help you to interact with Kompendium.
Some functionality is not possible or difficult to do with Kompendium by default. Modules in this folder help you to get
functionality that would otherwise be difficult.
The first one of which is [Protobuf java converter](protobuf_java_converter.md) which translates java protobuf classes
to `customTypes` entries.

View File

@ -0,0 +1,153 @@
The `Protobuf java converter` functions allow you to generate documentation from your generated Java classes.
Since Kompendium relies a lot on `KProperties` we have yet to find a way to connect this with our Java.
For now the documentation is generated for the `customTypes` in `NotarizedApplication`.
## Usage with Kotlinx
setup:
```kotlin
install(ContentNegotiation) {
json(Json {
encodeDefaults = false
// Combine the kompendium serializers with your custom java proto serializers
serializersModule =
KompendiumSerializersModule.module + SerializersModule { serializersModule = yourCustomProtoSerializers }
})
}
```
For one message and all its nested sub messages:
```kotlin
private fun Application.mainModule() {
// ...
install(NotarizedApplication()) {
spec = baseSpec
customTypes = MyJavaProto.getDefaultInstance().createCustomTypesForTypeAndSubTypes().toMap()
}
}
```
For multiple messages and their submesages:
```kotlin
private fun Application.mainModule() {
// ...
install(NotarizedApplication()) {
spec = baseSpec
customTypes = MyJavaProto.getDefaultInstance().createCustomTypesForTypeAndSubTypes()
.plus(AnotherJavaProto.getDefaultInstance().createCustomTypesForTypeAndSubTypes()).toMap()
}
}
```
### Example User
The protobuf that is used on our endpoint
```proto
message User {
string id = 1;
string email = 2;
string mobile_phone = 3;
string name = 4;
}
```
A custom serializer deserializer:
```kotlin
@OptIn(ExperimentalSerializationApi::class)
object UserSerializer : KSerializer<User> {
override val descriptor: SerialDescriptor = buildClassSerialDescriptor("User") {
element("id", serialDescriptor<String>())
element("email", serialDescriptor<String>())
element("mobile_phone", serialDescriptor<String>())
element("name", serialDescriptor<String>())
}
override fun deserialize(decoder: Decoder): User {
return decoder.decodeStructure(descriptor) {
var id: String? = null
var email: String? = null
var mobilePhone: String? = null
var name: String? = null
loop@ while (true) {
when (val index = decodeElementIndex(descriptor)) {
CompositeDecoder.DECODE_DONE -> break@loop
0 -> id = decodeStringElement(descriptor, index)
1 -> email = decodeStringElement(descriptor, index)
2 -> mobilePhone = decodeStringElement(descriptor, index)
3 -> name = decodeStringElement(descriptor, index)
else -> throw RuntimeException(
"Unexpected index field ${descriptor.getElementName(index)}"
)
}
}
// building the protobuf object
val user = User.newBuilder().apply {
id?.let { v -> this.id = v }
email?.let { v -> this.email = v }
mobilePhone?.let { v -> this.mobilePhone = v }
name?.let { v -> this.name = v }
}.build()
user
}
}
override fun serialize(encoder: Encoder, value: User) {
encoder.encodeStructure(descriptor) {
encodeStringElement(descriptor, 0, value.id)
encodeStringElement(descriptor, 1, value.email)
encodeStringElement(descriptor, 2, value.mobilePhone)
encodeStringElement(descriptor, 3, value.name)
}
}
}
```
Setting the content type:
```kotlin
install(ContentNegotiation) {
json(Json {
encodeDefaults = false
// Combine the kompendium serializers with your custom java proto serializers
serializersModule =
KompendiumSerializersModule.module + SerializersModule {
serializersModule = SerializersModule {
contextual(UserSerializer)
}
}
})
}
```
The installation of the noterized application:
```kotlin
install(NotarizedApplication()) {
spec = baseSpec
customTypes = User.getDefaultInstance().createCustomTypesForTypeAndSubTypes().toMap()
}
```
Route configuration as you normally would with one exception which is `createType()` to create kotlin type from a javaClass.
```kotlin
private fun Route.userDocumentation() {
install(NotarizedRoute()) {
post = PostInfo.builder {
summary("My User API")
description("Create a user")
request {
requestType(User::class.createType())
description("My user creation object")
}
response {
responseCode(HttpStatusCode.OK)
responseType(CreateUserResponse::class.createType())
description("Returns simulation object")
}
canRespond {
responseCode(HttpStatusCode.NotFound)
responseType<String>()
description("Indicates that the user could not be found")
}
}
}
}
```

View File

@ -13,6 +13,7 @@ At the moment, the following playground applications are
| Hidden Docs | Place your generated documentation behind authorization | | Hidden Docs | Place your generated documentation behind authorization |
| Jackson | Serialization using Jackson instead of the default KotlinX | | Jackson | Serialization using Jackson instead of the default KotlinX |
| Locations | Using the Ktor Locations API to define routes | | Locations | Using the Ktor Locations API to define routes |
| Resources | Using the Ktor Resources API to define routes |
You can find all of the playground You can find all of the playground
examples [here](https://github.com/bkbnio/kompendium/tree/main/playground/src/main/kotlin/io/bkbn/kompendium/playground) examples [here](https://github.com/bkbnio/kompendium/tree/main/playground/src/main/kotlin/io/bkbn/kompendium/playground)

View File

@ -0,0 +1,125 @@
The Ktor Resources API allows users to define their routes in a type-safe manner.
You can read more about it [here](https://ktor.io/docs/type-safe-routing.html).
Kompendium supports Ktor-Resources through an ancillary module `kompendium-resources`
{% hint style="warning" %}
The resources module contains _two_ plugins: `KompendiumResources` and `KompendiumResource`. You will find more
information on both below, but in a nutshell, the former is an application level plugin intended to define your entire
application, while the latter is a route level approach should you wish to split out your route definitions.
{% endhint %}
## Adding the Artifact
Prior to documenting your resources, you will need to add the artifact to your gradle build file.
```kotlin
dependencies {
implementation("io.bkbn:kompendium-resources:$version")
}
```
## NotarizedResources
The `NotarizedResources` plugin is an _application_ level plugin, and **must** be installed after both the
`NotarizedApplication` plugin and the Ktor `Resources` plugin. It is intended to be used to document your entire
application in a single block.
```kotlin
private fun Application.mainModule() {
install(Resources)
install(NotarizedApplication()) {
spec = baseSpec
}
install(NotarizedResources()) {
resources = mapOf(
Listing::class to NotarizedResources.ResourceMetadata(
parameters = listOf(
Parameter(
name = "name",
`in` = Parameter.Location.path,
schema = TypeDefinition.STRING
),
Parameter(
name = "page",
`in` = Parameter.Location.path,
schema = TypeDefinition.INT
)
),
get = GetInfo.builder {
summary("Get user by id")
description("A very neat endpoint!")
response {
responseCode(HttpStatusCode.OK)
responseType<ExampleResponse>()
description("Will return whether or not the user is real 😱")
}
}
),
)
}
}
```
Here, the `resources` property is a map of `KClass<*>` to `ResourceMetadata` instance describing that resource. This
metadata is functionally identical to how a standard `NotarizedRoute` is defined.
{% hint style="danger" %}
If you try to map a class that is not annotated with the ktor `@Resource` annotation, you will get a runtime exception!
{% endhint %}
## NotarizedResource
If you prefer a route-based approach similar to `NotarizedRoute`, you can use the `NotarizedResource<MyResourceType>()`
plugin instead of `NotarizedResources`. It will combine paths from any parent route with the route defined in the
resource, exactly as Ktor itself does:
```kotlin
@Serializable
@Resource("/list/{name}/page/{page}")
data class Listing(val name: String, val page: Int)
private fun Application.mainModule() {
install(Resources)
route("/api") {
listingDocumentation()
get<Listing> { listing ->
call.respondText("Listing ${listing.name}, page ${listing.page}")
}
}
}
private fun Route.listingDocumentation() {
install(NotarizedResource<Listing>()) {
parameters = listOf(
Parameter(
name = "name",
`in` = Parameter.Location.path,
schema = TypeDefinition.STRING
),
Parameter(
name = "page",
`in` = Parameter.Location.path,
schema = TypeDefinition.INT
)
)
get = GetInfo.builder {
summary("Get user by id")
description("A very neat endpoint!")
response {
responseCode(HttpStatusCode.OK)
responseType<ExampleResponse>()
description("Will return whether or not the user is real 😱")
}
}
}
}
```
In this case, the generated path will be `/api/list/{name}/page/{page}`, combining the route prefix with the path in the
resource.
{% hint style="danger" %}
If you try to map a class that is not annotated with the ktor `@Resource` annotation, you will get a runtime exception!
{% endhint %}

View File

@ -165,3 +165,128 @@ get = GetInfo.builder {
} }
} }
``` ```
## Media Types
By default, Kompendium will set the only media type to "application/json". If you would like to override the media type
for a specific request or response (including errors), you can do so with the `mediaTypes` method
```kotlin
get = GetInfo.builder {
summary("Get user by id")
description("A very neat endpoint!")
response {
mediaTypes("application/xml")
responseCode(HttpStatusCode.OK)
responseType<ExampleResponse>()
description("Will return whether or not the user is real 😱")
}
}
```
## Partial Authentication
One might want to have a public GET endpoint but a protected PUT endpoint. This can be achieved by registering two
separate notarized routes. Note that you will get an error if you try to register the same method twice, as each path
can only have one registration per method. Example:
```kotlin
route("/user/{id}") {
get = GetInfo.builder {
// ...
}
// ...
authenticate {
put = PutInfo.builder {
// ...
}
// ...
}
}
```
## Enrichment
Kompendium allows users to enrich their data types with additional information. This can be done by defining a
`TypeEnrichment` object and passing it to the `enrich` function on the `NotarizedRoute` builder. Enrichments
can be added to any request or response.
```kotlin
data class SimpleData(val a: String, val b: Int? = null)
val myEnrichment = TypeEnrichment<SimpleData>(id = "simple-enrichment") {
SimpleData::a {
description = "This will update the field description"
}
SimpleData::b {
// Will indicate in the UI that the field will be removed soon
deprecated = true
}
}
// In your route documentation
fun Routing.enrichedSimpleRequest() {
route("/example") {
install(NotarizedRoute()) {
parameters = TestModules.defaultParams
post = PostInfo.builder {
summary(TestModules.defaultPathSummary)
description(TestModules.defaultPathDescription)
request {
requestType<SimpleData>(enrichment = myEnrichment) // Simply attach the enrichment to the request
description("A test request")
}
response {
responseCode(HttpStatusCode.Created)
responseType<TestCreatedResponse>()
description(TestModules.defaultResponseDescription)
}
}
}
}
}
```
{% hint style="warning" %}
An enrichment must provide an `id` field that is unique to the data class that is being enriched. This is because
under the hood, Kompendium appends this id to the data class identifier in order to support multiple different
enrichments
on the same data class.
If you provide duplicate ids, all but the first enrichment will be ignored, as Kompendium will view that as a cache hit,
and skip analyzing the new enrichment.
{% endhint %}
At the moment, the only available enrichments are the following
- description -> Provides a reader friendly description of the field in the object
- deprecated -> Indicates that the field is deprecated and should not be used
### Nested Enrichments
Enrichments are portable and composable, meaning that we can take an enrichment for a child data class
and apply it inside a parent data class using the `typeEnrichment` property.
```kotlin
data class ParentData(val a: String, val b: ChildData)
data class ChildData(val c: String, val d: Int? = null)
val childEnrichment = TypeEnrichment<ChildData>(id = "child-enrichment") {
ChildData::c {
description = "This will update the field description of field c on child data"
}
ChildData::d {
description = "This will update the field description of field d on child data"
}
}
val parentEnrichment = TypeEnrichment<ParentData>(id = "parent-enrichment") {
ParentData::a {
description = "This will update the field description"
}
ParentData::b {
description = "This will update the field description of field b on parent data"
typeEnrichment = childEnrichment // Will apply the child enrichment to the internals of field b
}
}
```

View File

@ -0,0 +1,34 @@
plugins {
kotlin("jvm")
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("org.jetbrains.kotlinx.kover")
}
sourdoughLibrary {
libraryName.set("Kompendium Type Enrichment")
libraryDescription.set("Utility library for creating portable type enrichments")
compilerArgs.set(listOf("-opt-in=kotlin.RequiresOptIn"))
}
dependencies {
// Versions
val detektVersion: String by project
// Formatting
detektPlugins("io.gitlab.arturbosch.detekt:detekt-formatting:$detektVersion")
testImplementation(testFixtures(projects.kompendiumCore))
}
testing {
suites {
named("test", JvmTestSuite::class) {
useJUnitJupiter()
}
}
}

View File

@ -0,0 +1,3 @@
package io.bkbn.kompendium.enrichment
sealed interface Enrichment

View File

@ -0,0 +1,7 @@
package io.bkbn.kompendium.enrichment
class PropertyEnrichment : Enrichment {
var deprecated: Boolean? = null
var description: String? = null
var typeEnrichment: TypeEnrichment<*>? = null
}

View File

@ -0,0 +1,25 @@
package io.bkbn.kompendium.enrichment
import kotlin.reflect.KProperty
import kotlin.reflect.KProperty1
class TypeEnrichment<T>(val id: String) : Enrichment {
private val enrichments: MutableMap<KProperty1<*, *>, Enrichment> = mutableMapOf()
fun getEnrichmentForProperty(property: KProperty<*>): Enrichment? = enrichments[property]
operator fun <R> KProperty1<T, R>.invoke(init: PropertyEnrichment.() -> Unit) {
require(!enrichments.containsKey(this)) { "${this.name} has already been registered" }
val propertyEnrichment = PropertyEnrichment()
init.invoke(propertyEnrichment)
enrichments[this] = propertyEnrichment
}
companion object {
inline operator fun <reified T> invoke(id: String, init: TypeEnrichment<T>.() -> Unit): TypeEnrichment<T> {
val builder = TypeEnrichment<T>(id)
return builder.apply(init)
}
}
}

View File

@ -1,5 +1,5 @@
# Kompendium # Kompendium
project.version=3.4.0 project.version=3.10.0
# Kotlin # Kotlin
kotlin.code.style=official kotlin.code.style=official
# Gradle # Gradle
@ -8,6 +8,6 @@ org.gradle.vfs.verbose=true
org.gradle.jvmargs=-Xmx2000m org.gradle.jvmargs=-Xmx2000m
# Dependencies # Dependencies
ktorVersion=2.1.2 ktorVersion=2.2.1
kotestVersion=5.5.2 kotestVersion=5.5.4
detektVersion=1.21.0 detektVersion=1.21.0

Binary file not shown.

View File

@ -1,5 +1,5 @@
distributionBase=GRADLE_USER_HOME distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-bin.zip distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip
zipStoreBase=GRADLE_USER_HOME zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists zipStorePath=wrapper/dists

6
gradlew vendored
View File

@ -205,6 +205,12 @@ set -- \
org.gradle.wrapper.GradleWrapperMain \ org.gradle.wrapper.GradleWrapperMain \
"$@" "$@"
# Stop when "xargs" is not available.
if ! command -v xargs >/dev/null 2>&1
then
die "xargs is not available"
fi
# Use "xargs" to parse quoted args. # Use "xargs" to parse quoted args.
# #
# With -n1 it outputs one arg per line, with the quotes and backslashes removed. # With -n1 it outputs one arg per line, with the quotes and backslashes removed.

14
gradlew.bat vendored
View File

@ -14,7 +14,7 @@
@rem limitations under the License. @rem limitations under the License.
@rem @rem
@if "%DEBUG%" == "" @echo off @if "%DEBUG%"=="" @echo off
@rem ########################################################################## @rem ##########################################################################
@rem @rem
@rem Gradle startup script for Windows @rem Gradle startup script for Windows
@ -25,7 +25,7 @@
if "%OS%"=="Windows_NT" setlocal if "%OS%"=="Windows_NT" setlocal
set DIRNAME=%~dp0 set DIRNAME=%~dp0
if "%DIRNAME%" == "" set DIRNAME=. if "%DIRNAME%"=="" set DIRNAME=.
set APP_BASE_NAME=%~n0 set APP_BASE_NAME=%~n0
set APP_HOME=%DIRNAME% set APP_HOME=%DIRNAME%
@ -40,7 +40,7 @@ if defined JAVA_HOME goto findJavaFromJavaHome
set JAVA_EXE=java.exe set JAVA_EXE=java.exe
%JAVA_EXE% -version >NUL 2>&1 %JAVA_EXE% -version >NUL 2>&1
if "%ERRORLEVEL%" == "0" goto execute if %ERRORLEVEL% equ 0 goto execute
echo. echo.
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
@ -75,13 +75,15 @@ set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
:end :end
@rem End local scope for the variables with windows NT shell @rem End local scope for the variables with windows NT shell
if "%ERRORLEVEL%"=="0" goto mainEnd if %ERRORLEVEL% equ 0 goto mainEnd
:fail :fail
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
rem the _cmd.exe /c_ return code! rem the _cmd.exe /c_ return code!
if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 set EXIT_CODE=%ERRORLEVEL%
exit /b 1 if %EXIT_CODE% equ 0 set EXIT_CODE=1
if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
exit /b %EXIT_CODE%
:mainEnd :mainEnd
if "%OS%"=="Windows_NT" endlocal if "%OS%"=="Windows_NT" endlocal

View File

@ -20,7 +20,10 @@ dependencies {
// Versions // Versions
val detektVersion: String by project val detektVersion: String by project
implementation("org.jetbrains.kotlin:kotlin-reflect:1.7.20") // Kompendium
api(projects.kompendiumEnrichment)
implementation("org.jetbrains.kotlin:kotlin-reflect:1.8.0")
implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.4.1") implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.4.1")
// Formatting // Formatting

View File

@ -1,5 +1,6 @@
package io.bkbn.kompendium.json.schema package io.bkbn.kompendium.json.schema
import io.bkbn.kompendium.enrichment.TypeEnrichment
import io.bkbn.kompendium.json.schema.definition.JsonSchema import io.bkbn.kompendium.json.schema.definition.JsonSchema
import io.bkbn.kompendium.json.schema.definition.NullableDefinition import io.bkbn.kompendium.json.schema.definition.NullableDefinition
import io.bkbn.kompendium.json.schema.definition.OneOfDefinition import io.bkbn.kompendium.json.schema.definition.OneOfDefinition
@ -9,28 +10,26 @@ import io.bkbn.kompendium.json.schema.handler.EnumHandler
import io.bkbn.kompendium.json.schema.handler.MapHandler import io.bkbn.kompendium.json.schema.handler.MapHandler
import io.bkbn.kompendium.json.schema.handler.SealedObjectHandler import io.bkbn.kompendium.json.schema.handler.SealedObjectHandler
import io.bkbn.kompendium.json.schema.handler.SimpleObjectHandler import io.bkbn.kompendium.json.schema.handler.SimpleObjectHandler
import io.bkbn.kompendium.json.schema.util.Helpers.getSimpleSlug import io.bkbn.kompendium.json.schema.util.Helpers.getSlug
import java.util.UUID
import kotlin.reflect.KClass import kotlin.reflect.KClass
import kotlin.reflect.KType import kotlin.reflect.KType
import kotlin.reflect.full.isSubclassOf import kotlin.reflect.full.isSubclassOf
import kotlin.reflect.typeOf
import java.util.UUID
object SchemaGenerator { object SchemaGenerator {
inline fun <reified T : Any?> fromTypeToSchema(
cache: MutableMap<String, JsonSchema> = mutableMapOf(),
schemaConfigurator: SchemaConfigurator = SchemaConfigurator.Default()
) = fromTypeToSchema(typeOf<T>(), cache, schemaConfigurator)
fun fromTypeToSchema( fun fromTypeToSchema(
type: KType, type: KType,
cache: MutableMap<String, JsonSchema>, cache: MutableMap<String, JsonSchema>,
schemaConfigurator: SchemaConfigurator schemaConfigurator: SchemaConfigurator,
enrichment: TypeEnrichment<*>? = null
): JsonSchema { ): JsonSchema {
cache[type.getSimpleSlug()]?.let { val slug = type.getSlug(enrichment)
cache[slug]?.let {
return it return it
} }
return when (val clazz = type.classifier as KClass<*>) { return when (val clazz = type.classifier as KClass<*>) {
Unit::class -> error( Unit::class -> error(
""" """
@ -48,14 +47,14 @@ object SchemaGenerator {
Boolean::class -> checkForNull(type, TypeDefinition.BOOLEAN) Boolean::class -> checkForNull(type, TypeDefinition.BOOLEAN)
UUID::class -> checkForNull(type, TypeDefinition.UUID) UUID::class -> checkForNull(type, TypeDefinition.UUID)
else -> when { else -> when {
clazz.isSubclassOf(Enum::class) -> EnumHandler.handle(type, clazz) clazz.isSubclassOf(Enum::class) -> EnumHandler.handle(type, clazz, cache, enrichment)
clazz.isSubclassOf(Collection::class) -> CollectionHandler.handle(type, cache, schemaConfigurator) clazz.isSubclassOf(Collection::class) -> CollectionHandler.handle(type, cache, schemaConfigurator, enrichment)
clazz.isSubclassOf(Map::class) -> MapHandler.handle(type, cache, schemaConfigurator) clazz.isSubclassOf(Map::class) -> MapHandler.handle(type, cache, schemaConfigurator, enrichment)
else -> { else -> {
if (clazz.isSealed) { if (clazz.isSealed) {
SealedObjectHandler.handle(type, clazz, cache, schemaConfigurator) SealedObjectHandler.handle(type, clazz, cache, schemaConfigurator, enrichment)
} else { } else {
SimpleObjectHandler.handle(type, clazz, cache, schemaConfigurator) SimpleObjectHandler.handle(type, clazz, cache, schemaConfigurator, enrichment)
} }
} }
} }
@ -65,11 +64,12 @@ object SchemaGenerator {
fun fromTypeOrUnit( fun fromTypeOrUnit(
type: KType, type: KType,
cache: MutableMap<String, JsonSchema> = mutableMapOf(), cache: MutableMap<String, JsonSchema> = mutableMapOf(),
schemaConfigurator: SchemaConfigurator schemaConfigurator: SchemaConfigurator,
enrichment: TypeEnrichment<*>? = null
): JsonSchema? = ): JsonSchema? =
when (type.classifier as KClass<*>) { when (type.classifier as KClass<*>) {
Unit::class -> null Unit::class -> null
else -> fromTypeToSchema(type, cache, schemaConfigurator) else -> fromTypeToSchema(type, cache, schemaConfigurator, enrichment)
} }
private fun checkForNull(type: KType, schema: JsonSchema): JsonSchema = when (type.isMarkedNullable) { private fun checkForNull(type: KType, schema: JsonSchema): JsonSchema = when (type.isMarkedNullable) {

View File

@ -3,4 +3,8 @@ package io.bkbn.kompendium.json.schema.definition
import kotlinx.serialization.Serializable import kotlinx.serialization.Serializable
@Serializable @Serializable
data class AnyOfDefinition(val anyOf: Set<JsonSchema>) : JsonSchema data class AnyOfDefinition(
val anyOf: Set<JsonSchema>,
override val deprecated: Boolean? = null,
override val description: String? = null,
) : JsonSchema

View File

@ -4,7 +4,9 @@ import kotlinx.serialization.Serializable
@Serializable @Serializable
data class ArrayDefinition( data class ArrayDefinition(
val items: JsonSchema val items: JsonSchema,
override val deprecated: Boolean? = null,
override val description: String? = null,
) : JsonSchema { ) : JsonSchema {
val type: String = "array" val type: String = "array"
} }

View File

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

View File

@ -11,6 +11,9 @@ import kotlinx.serialization.encoding.Encoder
@Serializable(with = JsonSchema.Serializer::class) @Serializable(with = JsonSchema.Serializer::class)
sealed interface JsonSchema { sealed interface JsonSchema {
val description: String?
val deprecated: Boolean?
object Serializer : KSerializer<JsonSchema> { object Serializer : KSerializer<JsonSchema> {
override val descriptor: SerialDescriptor = PrimitiveSerialDescriptor("JsonSchema", PrimitiveKind.STRING) override val descriptor: SerialDescriptor = PrimitiveSerialDescriptor("JsonSchema", PrimitiveKind.STRING)
override fun deserialize(decoder: Decoder): JsonSchema { override fun deserialize(decoder: Decoder): JsonSchema {

View File

@ -4,7 +4,9 @@ import kotlinx.serialization.Serializable
@Serializable @Serializable
data class MapDefinition( data class MapDefinition(
val additionalProperties: JsonSchema val additionalProperties: JsonSchema,
override val deprecated: Boolean? = null,
override val description: String? = null,
) : JsonSchema { ) : JsonSchema {
val type: String = "object" val type: String = "object"
} }

View File

@ -3,4 +3,8 @@ package io.bkbn.kompendium.json.schema.definition
import kotlinx.serialization.Serializable import kotlinx.serialization.Serializable
@Serializable @Serializable
data class NullableDefinition(val type: String = "null") : JsonSchema data class NullableDefinition(
val type: String = "null",
override val deprecated: Boolean? = null,
override val description: String? = null,
) : JsonSchema

View File

@ -3,6 +3,10 @@ package io.bkbn.kompendium.json.schema.definition
import kotlinx.serialization.Serializable import kotlinx.serialization.Serializable
@Serializable @Serializable
data class OneOfDefinition(val oneOf: Set<JsonSchema>) : JsonSchema { data class OneOfDefinition(
val oneOf: Set<JsonSchema>,
override val deprecated: Boolean? = null,
override val description: String? = null,
) : JsonSchema {
constructor(vararg types: JsonSchema) : this(types.toSet()) constructor(vararg types: JsonSchema) : this(types.toSet())
} }

View File

@ -3,4 +3,8 @@ package io.bkbn.kompendium.json.schema.definition
import kotlinx.serialization.Serializable import kotlinx.serialization.Serializable
@Serializable @Serializable
data class ReferenceDefinition(val `$ref`: String) : JsonSchema data class ReferenceDefinition(
val `$ref`: String,
override val deprecated: Boolean? = null,
override val description: String? = null,
) : JsonSchema

View File

@ -7,10 +7,11 @@ import kotlinx.serialization.Serializable
data class TypeDefinition( data class TypeDefinition(
val type: String, val type: String,
val format: String? = null, val format: String? = null,
val description: String? = null,
val properties: Map<String, JsonSchema>? = null, val properties: Map<String, JsonSchema>? = null,
val required: Set<String>? = null, val required: Set<String>? = null,
@Contextual val default: Any? = null, @Contextual val default: Any? = null,
override val deprecated: Boolean? = null,
override val description: String? = null,
) : JsonSchema { ) : JsonSchema {
fun withDefault(default: Any): TypeDefinition = this.copy(default = default) fun withDefault(default: Any): TypeDefinition = this.copy(default = default)

View File

@ -1,5 +1,6 @@
package io.bkbn.kompendium.json.schema.handler package io.bkbn.kompendium.json.schema.handler
import io.bkbn.kompendium.enrichment.TypeEnrichment
import io.bkbn.kompendium.json.schema.SchemaConfigurator import io.bkbn.kompendium.json.schema.SchemaConfigurator
import io.bkbn.kompendium.json.schema.SchemaGenerator import io.bkbn.kompendium.json.schema.SchemaGenerator
import io.bkbn.kompendium.json.schema.definition.ArrayDefinition import io.bkbn.kompendium.json.schema.definition.ArrayDefinition
@ -9,17 +10,22 @@ import io.bkbn.kompendium.json.schema.definition.OneOfDefinition
import io.bkbn.kompendium.json.schema.definition.ReferenceDefinition import io.bkbn.kompendium.json.schema.definition.ReferenceDefinition
import io.bkbn.kompendium.json.schema.definition.TypeDefinition import io.bkbn.kompendium.json.schema.definition.TypeDefinition
import io.bkbn.kompendium.json.schema.util.Helpers.getReferenceSlug import io.bkbn.kompendium.json.schema.util.Helpers.getReferenceSlug
import io.bkbn.kompendium.json.schema.util.Helpers.getSimpleSlug import io.bkbn.kompendium.json.schema.util.Helpers.getSlug
import kotlin.reflect.KType import kotlin.reflect.KType
object CollectionHandler { object CollectionHandler {
fun handle(type: KType, cache: MutableMap<String, JsonSchema>, schemaConfigurator: SchemaConfigurator): JsonSchema { fun handle(
type: KType,
cache: MutableMap<String, JsonSchema>,
schemaConfigurator: SchemaConfigurator,
enrichment: TypeEnrichment<*>? = null
): JsonSchema {
val collectionType = type.arguments.first().type val collectionType = type.arguments.first().type
?: error("This indicates a bug in Kompendium, please open a GitHub issue!") ?: error("This indicates a bug in Kompendium, please open a GitHub issue!")
val typeSchema = SchemaGenerator.fromTypeToSchema(collectionType, cache, schemaConfigurator).let { val typeSchema = SchemaGenerator.fromTypeToSchema(collectionType, cache, schemaConfigurator, enrichment).let {
if (it is TypeDefinition && it.type == "object") { if (it is TypeDefinition && it.type == "object") {
cache[collectionType.getSimpleSlug()] = it cache[collectionType.getSlug(enrichment)] = it
ReferenceDefinition(collectionType.getReferenceSlug()) ReferenceDefinition(collectionType.getReferenceSlug(enrichment))
} else { } else {
it it
} }

View File

@ -1,19 +1,24 @@
package io.bkbn.kompendium.json.schema.handler package io.bkbn.kompendium.json.schema.handler
import io.bkbn.kompendium.enrichment.TypeEnrichment
import io.bkbn.kompendium.json.schema.definition.EnumDefinition import io.bkbn.kompendium.json.schema.definition.EnumDefinition
import io.bkbn.kompendium.json.schema.definition.JsonSchema import io.bkbn.kompendium.json.schema.definition.JsonSchema
import io.bkbn.kompendium.json.schema.definition.NullableDefinition import io.bkbn.kompendium.json.schema.definition.ReferenceDefinition
import io.bkbn.kompendium.json.schema.definition.OneOfDefinition import io.bkbn.kompendium.json.schema.util.Helpers.getReferenceSlug
import io.bkbn.kompendium.json.schema.util.Helpers.getSlug
import kotlin.reflect.KClass import kotlin.reflect.KClass
import kotlin.reflect.KType import kotlin.reflect.KType
object EnumHandler { object EnumHandler {
fun handle(type: KType, clazz: KClass<*>): JsonSchema { fun handle(
type: KType,
clazz: KClass<*>,
cache: MutableMap<String, JsonSchema>,
enrichment: TypeEnrichment<*>? = null
): JsonSchema {
cache[type.getSlug(enrichment)] = ReferenceDefinition(type.getReferenceSlug(enrichment))
val options = clazz.java.enumConstants.map { it.toString() }.toSet() val options = clazz.java.enumConstants.map { it.toString() }.toSet()
val definition = EnumDefinition(enum = options) return EnumDefinition(type = "string", enum = options)
return when (type.isMarkedNullable) {
true -> OneOfDefinition(NullableDefinition(), definition)
false -> definition
}
} }
} }

View File

@ -1,5 +1,6 @@
package io.bkbn.kompendium.json.schema.handler package io.bkbn.kompendium.json.schema.handler
import io.bkbn.kompendium.enrichment.TypeEnrichment
import io.bkbn.kompendium.json.schema.SchemaConfigurator import io.bkbn.kompendium.json.schema.SchemaConfigurator
import io.bkbn.kompendium.json.schema.SchemaGenerator import io.bkbn.kompendium.json.schema.SchemaGenerator
import io.bkbn.kompendium.json.schema.definition.JsonSchema import io.bkbn.kompendium.json.schema.definition.JsonSchema
@ -9,21 +10,26 @@ import io.bkbn.kompendium.json.schema.definition.OneOfDefinition
import io.bkbn.kompendium.json.schema.definition.ReferenceDefinition import io.bkbn.kompendium.json.schema.definition.ReferenceDefinition
import io.bkbn.kompendium.json.schema.definition.TypeDefinition import io.bkbn.kompendium.json.schema.definition.TypeDefinition
import io.bkbn.kompendium.json.schema.util.Helpers.getReferenceSlug import io.bkbn.kompendium.json.schema.util.Helpers.getReferenceSlug
import io.bkbn.kompendium.json.schema.util.Helpers.getSimpleSlug import io.bkbn.kompendium.json.schema.util.Helpers.getSlug
import kotlin.reflect.KClass import kotlin.reflect.KClass
import kotlin.reflect.KType import kotlin.reflect.KType
object MapHandler { object MapHandler {
fun handle(type: KType, cache: MutableMap<String, JsonSchema>, schemaConfigurator: SchemaConfigurator): JsonSchema { fun handle(
type: KType,
cache: MutableMap<String, JsonSchema>,
schemaConfigurator: SchemaConfigurator,
enrichment: TypeEnrichment<*>? = null
): JsonSchema {
require(type.arguments.first().type?.classifier as KClass<*> == String::class) { require(type.arguments.first().type?.classifier as KClass<*> == String::class) {
"JSON requires that map keys MUST be Strings. You provided ${type.arguments.first().type}" "JSON requires that map keys MUST be Strings. You provided ${type.arguments.first().type}"
} }
val valueType = type.arguments[1].type ?: error("this indicates a bug in Kompendium, please open a GitHub issue") val valueType = type.arguments[1].type ?: error("this indicates a bug in Kompendium, please open a GitHub issue")
val valueSchema = SchemaGenerator.fromTypeToSchema(valueType, cache, schemaConfigurator).let { val valueSchema = SchemaGenerator.fromTypeToSchema(valueType, cache, schemaConfigurator, enrichment).let {
if (it is TypeDefinition && it.type == "object") { if (it is TypeDefinition && it.type == "object") {
cache[valueType.getSimpleSlug()] = it cache[valueType.getSlug(enrichment)] = it
ReferenceDefinition(valueType.getReferenceSlug()) ReferenceDefinition(valueType.getReferenceSlug(enrichment))
} else { } else {
it it
} }

View File

@ -1,5 +1,6 @@
package io.bkbn.kompendium.json.schema.handler package io.bkbn.kompendium.json.schema.handler
import io.bkbn.kompendium.enrichment.TypeEnrichment
import io.bkbn.kompendium.json.schema.SchemaConfigurator import io.bkbn.kompendium.json.schema.SchemaConfigurator
import io.bkbn.kompendium.json.schema.SchemaGenerator import io.bkbn.kompendium.json.schema.SchemaGenerator
import io.bkbn.kompendium.json.schema.definition.AnyOfDefinition import io.bkbn.kompendium.json.schema.definition.AnyOfDefinition
@ -7,7 +8,7 @@ import io.bkbn.kompendium.json.schema.definition.JsonSchema
import io.bkbn.kompendium.json.schema.definition.ReferenceDefinition import io.bkbn.kompendium.json.schema.definition.ReferenceDefinition
import io.bkbn.kompendium.json.schema.definition.TypeDefinition import io.bkbn.kompendium.json.schema.definition.TypeDefinition
import io.bkbn.kompendium.json.schema.util.Helpers.getReferenceSlug import io.bkbn.kompendium.json.schema.util.Helpers.getReferenceSlug
import io.bkbn.kompendium.json.schema.util.Helpers.getSimpleSlug import io.bkbn.kompendium.json.schema.util.Helpers.getSlug
import kotlin.reflect.KClass import kotlin.reflect.KClass
import kotlin.reflect.KType import kotlin.reflect.KType
import kotlin.reflect.full.createType import kotlin.reflect.full.createType
@ -18,15 +19,17 @@ object SealedObjectHandler {
type: KType, type: KType,
clazz: KClass<*>, clazz: KClass<*>,
cache: MutableMap<String, JsonSchema>, cache: MutableMap<String, JsonSchema>,
schemaConfigurator: SchemaConfigurator schemaConfigurator: SchemaConfigurator,
enrichment: TypeEnrichment<*>? = null,
): JsonSchema { ): JsonSchema {
val subclasses = clazz.sealedSubclasses val subclasses = clazz.sealedSubclasses
.map { it.createType(type.arguments) } .map { it.createType(type.arguments) }
.map { t -> .map { t ->
SchemaGenerator.fromTypeToSchema(t, cache, schemaConfigurator).let { js -> SchemaGenerator.fromTypeToSchema(t, cache, schemaConfigurator, enrichment).let { js ->
if (js is TypeDefinition && js.type == "object") { if (js is TypeDefinition && js.type == "object") {
cache[t.getSimpleSlug()] = js val slug = t.getSlug(enrichment)
ReferenceDefinition(t.getReferenceSlug()) cache[slug] = js
ReferenceDefinition(t.getReferenceSlug(enrichment))
} else { } else {
js js
} }

View File

@ -1,15 +1,21 @@
package io.bkbn.kompendium.json.schema.handler package io.bkbn.kompendium.json.schema.handler
import io.bkbn.kompendium.enrichment.PropertyEnrichment
import io.bkbn.kompendium.enrichment.TypeEnrichment
import io.bkbn.kompendium.json.schema.SchemaConfigurator import io.bkbn.kompendium.json.schema.SchemaConfigurator
import io.bkbn.kompendium.json.schema.SchemaGenerator import io.bkbn.kompendium.json.schema.SchemaGenerator
import io.bkbn.kompendium.json.schema.definition.AnyOfDefinition
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.JsonSchema
import io.bkbn.kompendium.json.schema.definition.MapDefinition
import io.bkbn.kompendium.json.schema.definition.NullableDefinition import io.bkbn.kompendium.json.schema.definition.NullableDefinition
import io.bkbn.kompendium.json.schema.definition.OneOfDefinition import io.bkbn.kompendium.json.schema.definition.OneOfDefinition
import io.bkbn.kompendium.json.schema.definition.ReferenceDefinition import io.bkbn.kompendium.json.schema.definition.ReferenceDefinition
import io.bkbn.kompendium.json.schema.definition.TypeDefinition import io.bkbn.kompendium.json.schema.definition.TypeDefinition
import io.bkbn.kompendium.json.schema.exception.UnknownSchemaException 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.getReferenceSlug
import io.bkbn.kompendium.json.schema.util.Helpers.getSimpleSlug import io.bkbn.kompendium.json.schema.util.Helpers.getSlug
import kotlin.reflect.KClass import kotlin.reflect.KClass
import kotlin.reflect.KProperty import kotlin.reflect.KProperty
import kotlin.reflect.KType import kotlin.reflect.KType
@ -25,26 +31,34 @@ object SimpleObjectHandler {
type: KType, type: KType,
clazz: KClass<*>, clazz: KClass<*>,
cache: MutableMap<String, JsonSchema>, cache: MutableMap<String, JsonSchema>,
schemaConfigurator: SchemaConfigurator schemaConfigurator: SchemaConfigurator,
enrichment: TypeEnrichment<*>?,
): JsonSchema { ): JsonSchema {
cache[type.getSimpleSlug()] = ReferenceDefinition(type.getReferenceSlug()) cache[type.getSlug(enrichment)] = ReferenceDefinition(type.getReferenceSlug(enrichment))
val typeMap = clazz.typeParameters.zip(type.arguments).toMap() val typeMap = clazz.typeParameters.zip(type.arguments).toMap()
val props = schemaConfigurator.serializableMemberProperties(clazz) val props = schemaConfigurator.serializableMemberProperties(clazz)
.filterNot { it.javaField == null } .filterNot { it.javaField == null }
.associate { prop -> .associate { prop ->
val propTypeEnrichment = when (val pe = enrichment?.getEnrichmentForProperty(prop)) {
is PropertyEnrichment -> pe
else -> null
}
val schema = when (prop.needsToInjectGenerics(typeMap)) { val schema = when (prop.needsToInjectGenerics(typeMap)) {
true -> handleNestedGenerics(typeMap, prop, cache, schemaConfigurator) true -> handleNestedGenerics(typeMap, prop, cache, schemaConfigurator, propTypeEnrichment)
false -> when (typeMap.containsKey(prop.returnType.classifier)) { false -> when (typeMap.containsKey(prop.returnType.classifier)) {
true -> handleGenericProperty(prop, typeMap, cache, schemaConfigurator) true -> handleGenericProperty(prop, typeMap, cache, schemaConfigurator, propTypeEnrichment)
false -> handleProperty(prop, cache, schemaConfigurator) false -> handleProperty(prop, cache, schemaConfigurator, propTypeEnrichment?.typeEnrichment)
} }
} }
val nullCheckSchema = when (prop.returnType.isMarkedNullable && !schema.isNullable()) { val enrichedSchema = propTypeEnrichment?.applyToSchema(schema) ?: schema
true -> OneOfDefinition(NullableDefinition(), schema)
false -> schema val nullCheckSchema = when (prop.returnType.isMarkedNullable && !enrichedSchema.isNullable()) {
true -> OneOfDefinition(NullableDefinition(), enrichedSchema)
false -> enrichedSchema
} }
schemaConfigurator.serializableName(prop) to nullCheckSchema schemaConfigurator.serializableName(prop) to nullCheckSchema
@ -71,16 +85,11 @@ object SimpleObjectHandler {
.map { schemaConfigurator.serializableName(it) } .map { schemaConfigurator.serializableName(it) }
.toSet() .toSet()
val definition = TypeDefinition( return TypeDefinition(
type = "object", type = "object",
properties = props, properties = props,
required = required required = required
) )
return when (type.isMarkedNullable) {
true -> OneOfDefinition(NullableDefinition(), definition)
false -> definition
}
} }
private fun KProperty<*>.needsToInjectGenerics( private fun KProperty<*>.needsToInjectGenerics(
@ -94,7 +103,8 @@ object SimpleObjectHandler {
typeMap: Map<KTypeParameter, KTypeProjection>, typeMap: Map<KTypeParameter, KTypeProjection>,
prop: KProperty<*>, prop: KProperty<*>,
cache: MutableMap<String, JsonSchema>, cache: MutableMap<String, JsonSchema>,
schemaConfigurator: SchemaConfigurator schemaConfigurator: SchemaConfigurator,
propEnrichment: PropertyEnrichment?
): JsonSchema { ): JsonSchema {
val propClass = prop.returnType.classifier as KClass<*> val propClass = prop.returnType.classifier as KClass<*>
val types = prop.returnType.arguments.map { val types = prop.returnType.arguments.map {
@ -102,10 +112,11 @@ object SimpleObjectHandler {
typeMap.filterKeys { k -> k.name == typeSymbol }.values.first() typeMap.filterKeys { k -> k.name == typeSymbol }.values.first()
} }
val constructedType = propClass.createType(types) val constructedType = propClass.createType(types)
return SchemaGenerator.fromTypeToSchema(constructedType, cache, schemaConfigurator).let { return SchemaGenerator.fromTypeToSchema(constructedType, cache, schemaConfigurator, propEnrichment?.typeEnrichment)
if (it.isOrContainsObjectDef()) { .let {
cache[constructedType.getSimpleSlug()] = it if (it.isOrContainsObjectOrEnumDef()) {
ReferenceDefinition(prop.returnType.getReferenceSlug()) cache[constructedType.getSlug(propEnrichment)] = it
ReferenceDefinition(prop.returnType.getReferenceSlug(propEnrichment))
} else { } else {
it it
} }
@ -116,14 +127,15 @@ object SimpleObjectHandler {
prop: KProperty<*>, prop: KProperty<*>,
typeMap: Map<KTypeParameter, KTypeProjection>, typeMap: Map<KTypeParameter, KTypeProjection>,
cache: MutableMap<String, JsonSchema>, cache: MutableMap<String, JsonSchema>,
schemaConfigurator: SchemaConfigurator schemaConfigurator: SchemaConfigurator,
propEnrichment: PropertyEnrichment?
): JsonSchema { ): JsonSchema {
val type = typeMap[prop.returnType.classifier]?.type val type = typeMap[prop.returnType.classifier]?.type
?: error("This indicates a bug in Kompendium, please open a GitHub issue") ?: error("This indicates a bug in Kompendium, please open a GitHub issue")
return SchemaGenerator.fromTypeToSchema(type, cache, schemaConfigurator).let { return SchemaGenerator.fromTypeToSchema(type, cache, schemaConfigurator, propEnrichment?.typeEnrichment).let {
if (it.isOrContainsObjectDef()) { if (it.isOrContainsObjectOrEnumDef()) {
cache[type.getSimpleSlug()] = it cache[type.getSlug(propEnrichment)] = it
ReferenceDefinition(type.getReferenceSlug()) ReferenceDefinition(type.getReferenceSlug(propEnrichment))
} else { } else {
it it
} }
@ -133,22 +145,36 @@ object SimpleObjectHandler {
private fun handleProperty( private fun handleProperty(
prop: KProperty<*>, prop: KProperty<*>,
cache: MutableMap<String, JsonSchema>, cache: MutableMap<String, JsonSchema>,
schemaConfigurator: SchemaConfigurator schemaConfigurator: SchemaConfigurator,
propEnrichment: TypeEnrichment<*>?
): JsonSchema = ): JsonSchema =
SchemaGenerator.fromTypeToSchema(prop.returnType, cache, schemaConfigurator).let { SchemaGenerator.fromTypeToSchema(prop.returnType, cache, schemaConfigurator, propEnrichment).let {
if (it.isOrContainsObjectDef()) { if (it.isOrContainsObjectOrEnumDef()) {
cache[prop.returnType.getSimpleSlug()] = it cache[prop.returnType.getSlug(propEnrichment)] = it
ReferenceDefinition(prop.returnType.getReferenceSlug()) ReferenceDefinition(prop.returnType.getReferenceSlug(propEnrichment))
} else { } else {
it it
} }
} }
private fun JsonSchema.isOrContainsObjectDef(): Boolean { private fun JsonSchema.isOrContainsObjectOrEnumDef(): Boolean {
val isTypeDef = this is TypeDefinition && type == "object" val isTypeDef = this is TypeDefinition && type == "object"
val isTypeDefOneOf = this is OneOfDefinition && this.oneOf.any { js -> js is TypeDefinition && js.type == "object" } val isTypeDefOneOf = this is OneOfDefinition && this.oneOf.any { js -> js is TypeDefinition && js.type == "object" }
return isTypeDef || isTypeDefOneOf val isEnumDef = this is EnumDefinition
val isEnumDefOneOf = this is OneOfDefinition && this.oneOf.any { js -> js is EnumDefinition }
return isTypeDef || isTypeDefOneOf || isEnumDef || isEnumDefOneOf
} }
private fun JsonSchema.isNullable(): Boolean = this is OneOfDefinition && this.oneOf.any { it is NullableDefinition } private fun JsonSchema.isNullable(): Boolean = this is OneOfDefinition && this.oneOf.any { it is NullableDefinition }
private fun PropertyEnrichment.applyToSchema(schema: JsonSchema): JsonSchema = when (schema) {
is AnyOfDefinition -> schema.copy(deprecated = deprecated, description = description)
is ArrayDefinition -> schema.copy(deprecated = deprecated, description = description)
is EnumDefinition -> schema.copy(deprecated = deprecated, description = description)
is MapDefinition -> schema.copy(deprecated = deprecated, description = description)
is NullableDefinition -> schema.copy(deprecated = deprecated, description = description)
is OneOfDefinition -> schema.copy(deprecated = deprecated, description = description)
is ReferenceDefinition -> schema.copy(deprecated = deprecated, description = description)
is TypeDefinition -> schema.copy(deprecated = deprecated, description = description)
}
} }

View File

@ -1,5 +1,8 @@
package io.bkbn.kompendium.json.schema.util package io.bkbn.kompendium.json.schema.util
import io.bkbn.kompendium.enrichment.Enrichment
import io.bkbn.kompendium.enrichment.PropertyEnrichment
import io.bkbn.kompendium.enrichment.TypeEnrichment
import kotlin.reflect.KClass import kotlin.reflect.KClass
import kotlin.reflect.KType import kotlin.reflect.KType
@ -7,12 +10,26 @@ object Helpers {
private const val COMPONENT_SLUG = "#/components/schemas" private const val COMPONENT_SLUG = "#/components/schemas"
fun KType.getSlug(enrichment: Enrichment? = null) = when (enrichment) {
is TypeEnrichment<*> -> getEnrichedSlug(enrichment)
is PropertyEnrichment -> error("Slugs should not be generated for field enrichments")
null -> getSimpleSlug()
}
fun KType.getSimpleSlug(): String = when { fun KType.getSimpleSlug(): String = when {
this.arguments.isNotEmpty() -> genericNameAdapter(this, classifier as KClass<*>) this.arguments.isNotEmpty() -> genericNameAdapter(this, classifier as KClass<*>)
else -> (classifier as KClass<*>).kompendiumSlug() ?: error("Could not determine simple name for $this") else -> (classifier as KClass<*>).kompendiumSlug() ?: error("Could not determine simple name for $this")
} }
fun KType.getReferenceSlug(): String = when { private fun KType.getEnrichedSlug(enrichment: TypeEnrichment<*>) = getSimpleSlug() + "-${enrichment.id}"
fun KType.getReferenceSlug(enrichment: Enrichment? = null): String = when (enrichment) {
is TypeEnrichment<*> -> getSimpleReferenceSlug() + "-${enrichment.id}"
is PropertyEnrichment -> error("Reference slugs should never be generated for field enrichments")
null -> getSimpleReferenceSlug()
}
private fun KType.getSimpleReferenceSlug() = when {
arguments.isNotEmpty() -> "$COMPONENT_SLUG/${genericNameAdapter(this, classifier as KClass<*>)}" arguments.isNotEmpty() -> "$COMPONENT_SLUG/${genericNameAdapter(this, classifier as KClass<*>)}"
else -> "$COMPONENT_SLUG/${(classifier as KClass<*>).kompendiumSlug()}" else -> "$COMPONENT_SLUG/${(classifier as KClass<*>).kompendiumSlug()}"
} }

View File

@ -2,6 +2,8 @@ package io.bkbn.kompendium.json.schema
import io.bkbn.kompendium.core.fixtures.ComplexRequest import io.bkbn.kompendium.core.fixtures.ComplexRequest
import io.bkbn.kompendium.core.fixtures.FlibbityGibbit import io.bkbn.kompendium.core.fixtures.FlibbityGibbit
import io.bkbn.kompendium.core.fixtures.NestedComplexItem
import io.bkbn.kompendium.core.fixtures.ObjectWithEnum
import io.bkbn.kompendium.core.fixtures.SerialNameObject import io.bkbn.kompendium.core.fixtures.SerialNameObject
import io.bkbn.kompendium.core.fixtures.SimpleEnum import io.bkbn.kompendium.core.fixtures.SimpleEnum
import io.bkbn.kompendium.core.fixtures.SlammaJamma import io.bkbn.kompendium.core.fixtures.SlammaJamma
@ -9,13 +11,15 @@ import io.bkbn.kompendium.core.fixtures.TestHelpers.getFileSnapshot
import io.bkbn.kompendium.core.fixtures.TestResponse import io.bkbn.kompendium.core.fixtures.TestResponse
import io.bkbn.kompendium.core.fixtures.TestSimpleRequest import io.bkbn.kompendium.core.fixtures.TestSimpleRequest
import io.bkbn.kompendium.core.fixtures.TransientObject import io.bkbn.kompendium.core.fixtures.TransientObject
import io.bkbn.kompendium.core.fixtures.UnbakcedObject import io.bkbn.kompendium.core.fixtures.UnbackedObject
import io.bkbn.kompendium.enrichment.TypeEnrichment
import io.bkbn.kompendium.json.schema.definition.JsonSchema import io.bkbn.kompendium.json.schema.definition.JsonSchema
import io.kotest.assertions.json.shouldEqualJson import io.kotest.assertions.json.shouldEqualJson
import io.kotest.assertions.throwables.shouldThrow import io.kotest.assertions.throwables.shouldThrow
import io.kotest.core.spec.style.DescribeSpec import io.kotest.core.spec.style.DescribeSpec
import kotlinx.serialization.json.Json import kotlinx.serialization.json.Json
import java.util.UUID import java.util.UUID
import kotlin.reflect.typeOf
class SchemaGeneratorTest : DescribeSpec({ class SchemaGeneratorTest : DescribeSpec({
describe("Scalars") { describe("Scalars") {
@ -40,6 +44,7 @@ class SchemaGeneratorTest : DescribeSpec({
jsonSchemaTest<ComplexRequest>("T0005__complex_object.json") jsonSchemaTest<ComplexRequest>("T0005__complex_object.json")
} }
it("Can generate the schema for a nullable object") { it("Can generate the schema for a nullable object") {
// Same schema as a non-nullable type, since the nullability will be handled on the property
jsonSchemaTest<TestSimpleRequest?>("T0006__nullable_object.json") jsonSchemaTest<TestSimpleRequest?>("T0006__nullable_object.json")
} }
it("Can generate the schema for a polymorphic object") { it("Can generate the schema for a polymorphic object") {
@ -52,7 +57,7 @@ class SchemaGeneratorTest : DescribeSpec({
jsonSchemaTest<TransientObject>("T0018__transient_object.json") jsonSchemaTest<TransientObject>("T0018__transient_object.json")
} }
it("Can generate the schema for object with unbacked property") { it("Can generate the schema for object with unbacked property") {
jsonSchemaTest<UnbakcedObject>("T0019__unbacked_object.json") jsonSchemaTest<UnbackedObject>("T0019__unbacked_object.json")
} }
it("Can generate the schema for object with SerialName annotation") { it("Can generate the schema for object with SerialName annotation") {
jsonSchemaTest<SerialNameObject>("T0020__serial_name_object.json") jsonSchemaTest<SerialNameObject>("T0020__serial_name_object.json")
@ -63,8 +68,12 @@ class SchemaGeneratorTest : DescribeSpec({
jsonSchemaTest<SimpleEnum>("T0007__simple_enum.json") jsonSchemaTest<SimpleEnum>("T0007__simple_enum.json")
} }
it("Can generate the schema for a nullable enum") { it("Can generate the schema for a nullable enum") {
// Same schema as a non-nullable enum, since the nullability will be handled on the property
jsonSchemaTest<SimpleEnum?>("T0008__nullable_enum.json") jsonSchemaTest<SimpleEnum?>("T0008__nullable_enum.json")
} }
it("Can generate the schema for an object with an enum property") {
jsonSchemaTest<ObjectWithEnum>("T0021__object_with_enum.json")
}
} }
describe("Arrays") { describe("Arrays") {
it("Can generate the schema for an array of scalars") { it("Can generate the schema for an array of scalars") {
@ -82,7 +91,13 @@ class SchemaGeneratorTest : DescribeSpec({
jsonSchemaTest<Map<String, Int>>("T0012__scalar_map.json") jsonSchemaTest<Map<String, Int>>("T0012__scalar_map.json")
} }
it("Throws an error when map keys are not strings") { it("Throws an error when map keys are not strings") {
shouldThrow<IllegalArgumentException> { SchemaGenerator.fromTypeToSchema<Map<Int, Int>>() } shouldThrow<IllegalArgumentException> {
SchemaGenerator.fromTypeToSchema(
typeOf<Map<Int, Int>>(),
cache = mutableMapOf(),
schemaConfigurator = KotlinXSchemaConfigurator()
)
}
} }
it("Can generate the schema for a map of objects") { it("Can generate the schema for a map of objects") {
jsonSchemaTest<Map<String, TestResponse>>("T0013__object_map.json") jsonSchemaTest<Map<String, TestResponse>>("T0013__object_map.json")
@ -91,6 +106,36 @@ class SchemaGeneratorTest : DescribeSpec({
jsonSchemaTest<Map<String, Int>?>("T0014__nullable_map.json") jsonSchemaTest<Map<String, Int>?>("T0014__nullable_map.json")
} }
} }
describe("Enrichment") {
it("Can attach an enrichment to a simple type") {
jsonSchemaTest<TestSimpleRequest>(
snapshotName = "T0022__enriched_simple_object.json",
enrichment = TypeEnrichment("simple") {
TestSimpleRequest::a {
description = "This is a simple description"
}
TestSimpleRequest::b {
deprecated = true
}
}
)
}
it("Can properly assign a reference to a nested enrichment") {
jsonSchemaTest<ComplexRequest>(
snapshotName = "T0023__enriched_nested_reference.json",
enrichment = TypeEnrichment("example") {
ComplexRequest::tables {
description = "Collection of important items"
typeEnrichment = TypeEnrichment("table") {
NestedComplexItem::name {
description = "The name of the table"
}
}
}
}
)
}
}
}) { }) {
companion object { companion object {
private val json = Json { private val json = Json {
@ -101,11 +146,14 @@ class SchemaGeneratorTest : DescribeSpec({
private fun JsonSchema.serialize() = json.encodeToString(JsonSchema.serializer(), this) private fun JsonSchema.serialize() = json.encodeToString(JsonSchema.serializer(), this)
private inline fun <reified T> jsonSchemaTest(snapshotName: String) { private inline fun <reified T> jsonSchemaTest(snapshotName: String, enrichment: TypeEnrichment<*>? = null) {
// act // act
val schema = SchemaGenerator.fromTypeToSchema<T>(schemaConfigurator = KotlinXSchemaConfigurator()) val schema = SchemaGenerator.fromTypeToSchema(
type = typeOf<T>(),
// todo add cache assertions!!! cache = mutableMapOf(),
schemaConfigurator = KotlinXSchemaConfigurator(),
enrichment = enrichment,
)
// assert // assert
schema.serialize() shouldEqualJson getFileSnapshot(snapshotName) schema.serialize() shouldEqualJson getFileSnapshot(snapshotName)

View File

@ -1,9 +1,4 @@
{ {
"oneOf": [
{
"type": "null"
},
{
"type": "object", "type": "object",
"properties": { "properties": {
"a": { "a": {
@ -18,6 +13,4 @@
"a", "a",
"b" "b"
] ]
}
]
} }

View File

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

View File

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

View File

@ -0,0 +1,11 @@
{
"type": "object",
"properties": {
"color": {
"$ref": "#/components/schemas/Color"
}
},
"required": [
"color"
]
}

View File

@ -0,0 +1,18 @@
{
"type": "object",
"properties": {
"a": {
"type": "string",
"description": "This is a simple description"
},
"b": {
"type": "number",
"format": "int32",
"deprecated": true
}
},
"required": [
"a",
"b"
]
}

View File

@ -0,0 +1,23 @@
{
"type": "object",
"properties": {
"amazingField": {
"type": "string"
},
"org": {
"type": "string"
},
"tables": {
"items": {
"$ref": "#/components/schemas/NestedComplexItem-table"
},
"description": "Collection of important items",
"type": "array"
}
},
"required": [
"amazingField",
"org",
"tables"
]
}

View File

@ -22,8 +22,8 @@ dependencies {
// IMPLEMENTATION // IMPLEMENTATION
implementation(projects.kompendiumCore) implementation(projects.kompendiumCore)
implementation("io.ktor:ktor-server-core:2.1.2") implementation("io.ktor:ktor-server-core:2.1.3")
implementation("io.ktor:ktor-server-locations:2.1.2") implementation("io.ktor:ktor-server-locations:2.1.3")
// TESTING // TESTING

View File

@ -20,6 +20,11 @@ import kotlin.reflect.full.findAnnotation
import kotlin.reflect.full.hasAnnotation import kotlin.reflect.full.hasAnnotation
import kotlin.reflect.full.memberProperties import kotlin.reflect.full.memberProperties
@Deprecated(
message = "This functionality is deprecated and will be removed in the future. " +
"Use 'ktor-server-resources' with 'kompendium-resources' plugin instead.",
level = DeprecationLevel.WARNING
)
object NotarizedLocations { object NotarizedLocations {
data class LocationMetadata( data class LocationMetadata(
@ -43,21 +48,20 @@ object NotarizedLocations {
name = "NotarizedLocations", name = "NotarizedLocations",
createConfiguration = ::Config createConfiguration = ::Config
) { ) {
println("hi")
val spec = application.attributes[KompendiumAttributes.openApiSpec] val spec = application.attributes[KompendiumAttributes.openApiSpec]
val serializableReader = application.attributes[KompendiumAttributes.schemaConfigurator] val serializableReader = application.attributes[KompendiumAttributes.schemaConfigurator]
pluginConfig.locations.forEach { (k, v) -> pluginConfig.locations.forEach { (k, v) ->
val path = Path()
path.parameters = v.parameters
v.get?.addToSpec(path, spec, v, serializableReader)
v.delete?.addToSpec(path, spec, v, serializableReader)
v.head?.addToSpec(path, spec, v, serializableReader)
v.options?.addToSpec(path, spec, v, serializableReader)
v.post?.addToSpec(path, spec, v, serializableReader)
v.put?.addToSpec(path, spec, v, serializableReader)
v.patch?.addToSpec(path, spec, v, serializableReader)
val location = k.getLocationFromClass() val location = k.getLocationFromClass()
val path = spec.paths[location] ?: Path()
path.parameters = path.parameters?.plus(v.parameters) ?: v.parameters
v.get?.addToSpec(path, spec, v, serializableReader, location)
v.delete?.addToSpec(path, spec, v, serializableReader, location)
v.head?.addToSpec(path, spec, v, serializableReader, location)
v.options?.addToSpec(path, spec, v, serializableReader, location)
v.post?.addToSpec(path, spec, v, serializableReader, location)
v.put?.addToSpec(path, spec, v, serializableReader, location)
v.patch?.addToSpec(path, spec, v, serializableReader, location)
spec.paths[location] = path spec.paths[location] = path
} }
} }

View File

@ -21,6 +21,7 @@ dependencies {
val detektVersion: String by project val detektVersion: String by project
api(projects.kompendiumJsonSchema) api(projects.kompendiumJsonSchema)
api(projects.kompendiumEnrichment)
implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.4.1") implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.4.1")
// Formatting // Formatting

View File

@ -14,6 +14,8 @@ dependencies {
// IMPLEMENTATION // IMPLEMENTATION
implementation(projects.kompendiumCore) implementation(projects.kompendiumCore)
implementation(projects.kompendiumLocations) implementation(projects.kompendiumLocations)
implementation(projects.kompendiumResources)
implementation(projects.kompendiumProtobufJavaConverter)
// Ktor // Ktor
val ktorVersion: String by project val ktorVersion: String by project
@ -29,17 +31,18 @@ dependencies {
implementation("io.ktor:ktor-serialization-jackson:$ktorVersion") implementation("io.ktor:ktor-serialization-jackson:$ktorVersion")
implementation("io.ktor:ktor-serialization-gson:$ktorVersion") implementation("io.ktor:ktor-serialization-gson:$ktorVersion")
implementation("io.ktor:ktor-server-locations:$ktorVersion") implementation("io.ktor:ktor-server-locations:$ktorVersion")
implementation("io.ktor:ktor-server-resources:$ktorVersion")
// Logging // Logging
implementation("org.apache.logging.log4j:log4j-api-kotlin:1.2.0") implementation("org.apache.logging.log4j:log4j-api-kotlin:1.2.0")
implementation("org.apache.logging.log4j:log4j-api:2.19.0") implementation("org.apache.logging.log4j:log4j-api:2.19.0")
implementation("org.apache.logging.log4j:log4j-core:2.19.0") implementation("org.apache.logging.log4j:log4j-core:2.19.0")
implementation("org.slf4j:slf4j-api:2.0.3") implementation("org.slf4j:slf4j-api:2.0.6")
implementation("org.slf4j:slf4j-simple:2.0.3") implementation("org.slf4j:slf4j-simple:2.0.6")
implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.4.1") implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.4.1")
implementation("org.jetbrains.kotlinx:kotlinx-datetime:0.4.0") implementation("org.jetbrains.kotlinx:kotlinx-datetime:0.4.0")
implementation("joda-time:joda-time:2.12.0") implementation("joda-time:joda-time:2.12.2")
} }

View File

@ -50,7 +50,6 @@ private fun Application.mainModule() {
} }
routing { routing {
redoc(pageTitle = "Simple API Docs") redoc(pageTitle = "Simple API Docs")
route("/{id}") { route("/{id}") {
idDocumentation() idDocumentation()
get { get {

View File

@ -0,0 +1,154 @@
package io.bkbn.kompendium.playground
import io.bkbn.kompendium.core.metadata.GetInfo
import io.bkbn.kompendium.core.metadata.PostInfo
import io.bkbn.kompendium.core.plugin.NotarizedApplication
import io.bkbn.kompendium.core.plugin.NotarizedRoute
import io.bkbn.kompendium.core.routes.redoc
import io.bkbn.kompendium.enrichment.TypeEnrichment
import io.bkbn.kompendium.json.schema.KotlinXSchemaConfigurator
import io.bkbn.kompendium.json.schema.definition.TypeDefinition
import io.bkbn.kompendium.oas.payload.Parameter
import io.bkbn.kompendium.oas.serialization.KompendiumSerializersModule
import io.bkbn.kompendium.playground.util.ExampleRequest
import io.bkbn.kompendium.playground.util.ExampleResponse
import io.bkbn.kompendium.playground.util.ExceptionResponse
import io.bkbn.kompendium.playground.util.InnerRequest
import io.bkbn.kompendium.playground.util.Util.baseSpec
import io.ktor.http.HttpStatusCode
import io.ktor.serialization.kotlinx.json.json
import io.ktor.server.application.Application
import io.ktor.server.application.call
import io.ktor.server.application.install
import io.ktor.server.cio.CIO
import io.ktor.server.engine.embeddedServer
import io.ktor.server.plugins.contentnegotiation.ContentNegotiation
import io.ktor.server.response.respond
import io.ktor.server.routing.*
import kotlinx.serialization.json.Json
fun main() {
embeddedServer(
CIO,
port = 8081,
module = Application::mainModule
).start(wait = true)
}
private fun Application.mainModule() {
install(ContentNegotiation) {
json(Json {
serializersModule = KompendiumSerializersModule.module
encodeDefaults = true
explicitNulls = false
})
}
install(NotarizedApplication()) {
spec = baseSpec
// Adds support for @Transient and @SerialName
// If you are not using them this is not required.
schemaConfigurator = KotlinXSchemaConfigurator()
}
routing {
redoc(pageTitle = "Simple API Docs")
enrichedDocumentation()
post {
call.respond(HttpStatusCode.OK, ExampleResponse(false))
}
}
}
private val testEnrichment = TypeEnrichment("testerino") {
ExampleRequest::thingA {
description = "This is a thing"
}
ExampleRequest::thingB {
description = "This is another thing"
}
ExampleRequest::thingC {
deprecated = true
description = "A good but old field"
typeEnrichment = TypeEnrichment("big-tings") {
InnerRequest::d {
description = "THE BIG D"
}
}
}
}
private val testResponseEnrichment = TypeEnrichment("testerino") {
ExampleResponse::isReal {
description = "Is this thing real or not?"
}
}
private fun Route.enrichedDocumentation() {
install(NotarizedRoute()) {
post = PostInfo.builder {
summary("Do a thing")
description("This is a thing")
request {
requestType(enrichment = testEnrichment)
description("This is the request")
}
response {
responseCode(HttpStatusCode.OK)
responseType(enrichment = testResponseEnrichment)
description("This is the response")
}
}
}
}
private fun Route.idDocumentation() {
install(NotarizedRoute()) {
parameters = listOf(
Parameter(
name = "id",
`in` = Parameter.Location.path,
schema = TypeDefinition.STRING
)
)
get = GetInfo.builder {
summary("Get user by id")
description("A very neat endpoint!")
response {
responseCode(HttpStatusCode.OK)
responseType<ExampleResponse>()
description("Will return whether or not the user is real 😱")
}
canRespond {
responseType<ExceptionResponse>()
responseCode(HttpStatusCode.NotFound)
description("Indicates that a user with this id does not exist")
}
}
}
}
private fun Route.profileDocumentation() {
install(NotarizedRoute()) {
parameters = listOf(
Parameter(
name = "id",
`in` = Parameter.Location.path,
schema = TypeDefinition.STRING
)
)
get = GetInfo.builder {
summary("Get a users profile")
description("A cool endpoint!")
response {
responseCode(HttpStatusCode.OK)
responseType<ExampleResponse>()
description("Returns user profile information")
}
canRespond {
responseType<ExceptionResponse>()
responseCode(HttpStatusCode.NotFound)
description("Indicates that a user with this id does not exist")
}
}
}
}

View File

@ -0,0 +1,85 @@
package io.bkbn.kompendium.playground
import io.bkbn.kompendium.core.metadata.GetInfo
import io.bkbn.kompendium.core.plugin.NotarizedApplication
import io.bkbn.kompendium.core.routes.redoc
import io.bkbn.kompendium.json.schema.definition.TypeDefinition
import io.bkbn.kompendium.oas.payload.Parameter
import io.bkbn.kompendium.oas.serialization.KompendiumSerializersModule
import io.bkbn.kompendium.playground.util.ExampleResponse
import io.bkbn.kompendium.playground.util.Util.baseSpec
import io.bkbn.kompendium.resources.NotarizedResources
import io.ktor.http.HttpStatusCode
import io.ktor.resources.Resource
import io.ktor.serialization.kotlinx.json.json
import io.ktor.server.application.Application
import io.ktor.server.application.call
import io.ktor.server.application.install
import io.ktor.server.cio.CIO
import io.ktor.server.engine.embeddedServer
import io.ktor.server.plugins.contentnegotiation.ContentNegotiation
import io.ktor.server.resources.Resources
import io.ktor.server.resources.get
import io.ktor.server.response.respondText
import io.ktor.server.routing.routing
import kotlinx.serialization.Serializable
import kotlinx.serialization.json.Json
fun main() {
embeddedServer(
CIO,
port = 8081,
module = Application::mainModule
).start(wait = true)
}
private fun Application.mainModule() {
install(Resources)
install(ContentNegotiation) {
json(Json {
serializersModule = KompendiumSerializersModule.module
encodeDefaults = true
explicitNulls = false
})
}
install(NotarizedApplication()) {
spec = baseSpec
}
install(NotarizedResources()) {
resources = mapOf(
ListingResource::class to NotarizedResources.ResourceMetadata(
parameters = listOf(
Parameter(
name = "name",
`in` = Parameter.Location.path,
schema = TypeDefinition.STRING
),
Parameter(
name = "page",
`in` = Parameter.Location.path,
schema = TypeDefinition.INT
)
),
get = GetInfo.builder {
summary("Get user by id")
description("A very neat endpoint!")
response {
responseCode(HttpStatusCode.OK)
responseType<ExampleResponse>()
description("Will return whether or not the user is real 😱")
}
}
),
)
}
routing {
redoc(pageTitle = "Simple API Docs")
get<ListingResource> { listing ->
call.respondText("Listing ${listing.name}, page ${listing.page}")
}
}
}
@Serializable
@Resource("/list/{name}/page/{page}")
data class ListingResource(val name: String, val page: Int)

View File

@ -5,6 +5,19 @@ import io.ktor.server.locations.Location
import kotlinx.datetime.Instant import kotlinx.datetime.Instant
import kotlinx.serialization.Serializable import kotlinx.serialization.Serializable
@Serializable
data class ExampleRequest(
val thingA: String,
val thingB: Int,
val thingC: InnerRequest,
)
@Serializable
data class InnerRequest(
val d: Float,
val e: Boolean,
)
@Serializable @Serializable
data class ExampleResponse(val isReal: Boolean) data class ExampleResponse(val isReal: Boolean)

View File

@ -0,0 +1,43 @@
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("org.jetbrains.kotlinx.kover")
}
sourdoughLibrary {
libraryName.set("Kompendium Protobuf java converter")
libraryDescription.set("Converts Java protobuf generated classes to custom type maps")
compilerArgs.set(listOf("-opt-in=kotlin.RequiresOptIn"))
}
dependencies {
// Versions
val detektVersion: String by project
implementation(projects.kompendiumJsonSchema)
implementation("com.google.protobuf:protobuf-java:3.21.12")
implementation("org.jetbrains.kotlin:kotlin-reflect:1.8.0")
implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.4.1")
// Formatting
detektPlugins("io.gitlab.arturbosch.detekt:detekt-formatting:$detektVersion")
testImplementation(testFixtures(projects.kompendiumCore))
}
testing {
suites {
named("test", JvmTestSuite::class) {
useJUnitJupiter()
}
}
}

View File

@ -0,0 +1,177 @@
package io.bkbn.kompendium.protobufjavaconverter.converters
import com.google.protobuf.Descriptors
import com.google.protobuf.GeneratedMessageV3
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.MapDefinition
import io.bkbn.kompendium.json.schema.definition.NullableDefinition
import io.bkbn.kompendium.json.schema.definition.ReferenceDefinition
import io.bkbn.kompendium.json.schema.definition.TypeDefinition
import kotlin.reflect.KType
import kotlin.reflect.full.createType
/**
* Extension function to generate all custom TypeDefinitions for.
*
* Traverses all fields and subfields of the message it also generates references for nested messages.
*
* @property GeneratedMessageV3 the protobuf message to generate all the custom definitions for
* @param snakeCase whether to convert the names to snake case or not
* @return a [Map] of ([KType], [TypeDefinition]) to be used in `customTypes` in [NoterizedApplication]
*
*/
fun GeneratedMessageV3.createCustomTypesForTypeAndSubTypes(snakeCase: Boolean = false): Map<KType, JsonSchema> {
val cache: MutableMap<String, JsonSchema> = mutableMapOf()
return mapOf(
this::class.createType() to TypeDefinition(
type = "object",
properties = toJsonSchemaMap(this.descriptorForType, cache, snakeCase)
)
)
// Dont forget to add the definitions for our references
.plus(
cache.map {
// Get the class from the respective key (which should be a fullname of the class
val clazz = Class.forName(it.key)
clazz.kotlin.createType() to it.value
}.toMap()
)
}
/**
* Loops over all fields of the provided Descriptor to discover the field types
*
* @param protoDescriptor the [Descriptors.FieldDescriptor] to convert
* @param cache map of cached definitions
* @param snakeCase whether to convert the names to snake case or not
* @return a [Map] of ([String], [JsonSchema])
*
*/
fun toJsonSchemaMap(
protoDescriptor: Descriptors.Descriptor,
cache: MutableMap<String, JsonSchema> = mutableMapOf(),
snakeCase: Boolean = false
): Map<String, JsonSchema> =
protoDescriptor.fields.map {
val key = if (snakeCase) it.jsonName.toSnakeCase() else it.jsonName
key to fromNestedTypeToSchema(it, cache)
}.toMap()
/**
* Very simple snake case conversion
*/
fun String.toSnakeCase() =
this.map {
if (it.isUpperCase()) "_${it.lowercase()}" else it.toString()
}.reduce { acc, s -> acc + s }
/**
* Converts a field from a proto message to a JsonSchema
*
* @param javaProtoField the [Descriptors.FieldDescriptor] to convert
* @param cache map of cached definitions
* @return the resulting [JsonSchema]
*
*/
fun fromNestedTypeToSchema(
javaProtoField: Descriptors.FieldDescriptor,
cache: MutableMap<String, JsonSchema> = mutableMapOf()
): JsonSchema =
when {
javaProtoField.isRepeated && !javaProtoField.isMapField -> ArrayDefinition(fromTypeToSchema(javaProtoField, cache))
javaProtoField.isMapField -> handleMapField(javaProtoField, cache)
else -> fromTypeToSchema(javaProtoField, cache)
}
/**
* Converts a map field descriptor
*
* It generates some key examples based on the type provided and gets the TypeDefinition of the value.
*
* @param javaProtoField the field to convert (which should be a mapField)
* @param cache map of cached definitions
* @return returns the a [MapDefinition] schema with additional properties to describe the key and value
*/
@Suppress("MagicNumber")
fun handleMapField(
javaProtoField: Descriptors.FieldDescriptor,
cache: MutableMap<String, JsonSchema> = mutableMapOf()
): JsonSchema {
require(javaProtoField.isMapField) { "Should never be called for a non map type" }
val keyField = javaProtoField.containingType.nestedTypes.first().findFieldByName("key")
val valueField = javaProtoField.containingType.nestedTypes.first().findFieldByName("value")
val valueType = fromTypeToSchema(valueField, cache)
// Keys can only be string in json but we can still have "0", "0.0" or "true", "ENUM_VALUE" as keys
val keys: List<String> = when (keyField.javaType) {
Descriptors.FieldDescriptor.JavaType.INT,
Descriptors.FieldDescriptor.JavaType.LONG -> (0..1).map { it.toString() }
Descriptors.FieldDescriptor.JavaType.FLOAT,
Descriptors.FieldDescriptor.JavaType.DOUBLE -> listOf(0.0, 0.1, 0.2).map { it.toString() }
Descriptors.FieldDescriptor.JavaType.BOOLEAN -> listOf(true, false).map { it.toString() }
Descriptors.FieldDescriptor.JavaType.STRING -> (0..1).map { "myVariable$it" }
Descriptors.FieldDescriptor.JavaType.BYTE_STRING -> (0..1).map { "0x$it" }
Descriptors.FieldDescriptor.JavaType.ENUM -> (0..1).map { "ENUM_VALUE$it" }
null,
Descriptors.FieldDescriptor.JavaType.MESSAGE -> throw IllegalArgumentException("Cant use object as key")
}
return MapDefinition(
TypeDefinition(
type = "object",
properties = keys.map { it to valueType }.toMap()
)
)
}
/**
* Converts scalar, enum and message type descriptors to TypeDefinitions
*
* @param javaProtoField the field to convert
* @param cache map of cached definitions
* @return returns a matching [JsonSchema]
*/
fun fromTypeToSchema(
javaProtoField: Descriptors.FieldDescriptor,
cache: MutableMap<String, JsonSchema> = mutableMapOf()
): JsonSchema {
checkTypeCache(javaProtoField, cache)?.let { return it }
return when (javaProtoField.javaType) {
Descriptors.FieldDescriptor.JavaType.INT -> TypeDefinition.INT
Descriptors.FieldDescriptor.JavaType.LONG -> TypeDefinition.LONG
Descriptors.FieldDescriptor.JavaType.FLOAT -> TypeDefinition.FLOAT
Descriptors.FieldDescriptor.JavaType.DOUBLE -> TypeDefinition.DOUBLE
Descriptors.FieldDescriptor.JavaType.BOOLEAN -> TypeDefinition.BOOLEAN
Descriptors.FieldDescriptor.JavaType.STRING -> TypeDefinition.STRING
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(javaProtoField.enumType.name)
}
Descriptors.FieldDescriptor.JavaType.MESSAGE -> {
// Traverse through possible nested messages
cache[javaProtoField.messageType.fullName] = TypeDefinition(
type = "object",
properties = javaProtoField.messageType.fields.map {
it.jsonName to fromNestedTypeToSchema(it, cache)
}.toMap()
)
ReferenceDefinition(javaProtoField.messageType.name)
}
null -> NullableDefinition()
}
}
fun checkTypeCache(
javaProtoField: Descriptors.FieldDescriptor,
cache: MutableMap<String, JsonSchema>
): JsonSchema? =
when (javaProtoField.javaType) {
Descriptors.FieldDescriptor.JavaType.ENUM -> cache[javaProtoField.enumType.name]
Descriptors.FieldDescriptor.JavaType.MESSAGE -> cache[javaProtoField.messageType.name]
else -> null
}

View File

@ -0,0 +1,167 @@
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: io/bkbn/kompendium/protobufjavaconverter/converters/test.proto
package io.bkbn.kompendium.protobufjavaconverter;
/**
* Protobuf enum {@code io.bkbn.kompendium.protobufjavaconverter.Corpus}
*/
public enum Corpus
implements com.google.protobuf.ProtocolMessageEnum {
/**
* <code>CORPUS_UNSPECIFIED = 0;</code>
*/
CORPUS_UNSPECIFIED(0),
/**
* <code>CORPUS_UNIVERSAL = 1;</code>
*/
CORPUS_UNIVERSAL(1),
/**
* <code>CORPUS_WEB = 2;</code>
*/
CORPUS_WEB(2),
/**
* <code>CORPUS_IMAGES = 3;</code>
*/
CORPUS_IMAGES(3),
/**
* <code>CORPUS_LOCAL = 4;</code>
*/
CORPUS_LOCAL(4),
/**
* <code>CORPUS_NEWS = 5;</code>
*/
CORPUS_NEWS(5),
/**
* <code>CORPUS_PRODUCTS = 6;</code>
*/
CORPUS_PRODUCTS(6),
/**
* <code>CORPUS_VIDEO = 7;</code>
*/
CORPUS_VIDEO(7),
UNRECOGNIZED(-1),
;
/**
* <code>CORPUS_UNSPECIFIED = 0;</code>
*/
public static final int CORPUS_UNSPECIFIED_VALUE = 0;
/**
* <code>CORPUS_UNIVERSAL = 1;</code>
*/
public static final int CORPUS_UNIVERSAL_VALUE = 1;
/**
* <code>CORPUS_WEB = 2;</code>
*/
public static final int CORPUS_WEB_VALUE = 2;
/**
* <code>CORPUS_IMAGES = 3;</code>
*/
public static final int CORPUS_IMAGES_VALUE = 3;
/**
* <code>CORPUS_LOCAL = 4;</code>
*/
public static final int CORPUS_LOCAL_VALUE = 4;
/**
* <code>CORPUS_NEWS = 5;</code>
*/
public static final int CORPUS_NEWS_VALUE = 5;
/**
* <code>CORPUS_PRODUCTS = 6;</code>
*/
public static final int CORPUS_PRODUCTS_VALUE = 6;
/**
* <code>CORPUS_VIDEO = 7;</code>
*/
public static final int CORPUS_VIDEO_VALUE = 7;
public final int getNumber() {
if (this == UNRECOGNIZED) {
throw new java.lang.IllegalArgumentException(
"Can't get the number of an unknown enum value.");
}
return value;
}
/**
* @param value The numeric wire value of the corresponding enum entry.
* @return The enum associated with the given numeric wire value.
* @deprecated Use {@link #forNumber(int)} instead.
*/
@java.lang.Deprecated
public static Corpus valueOf(int value) {
return forNumber(value);
}
/**
* @param value The numeric wire value of the corresponding enum entry.
* @return The enum associated with the given numeric wire value.
*/
public static Corpus forNumber(int value) {
switch (value) {
case 0: return CORPUS_UNSPECIFIED;
case 1: return CORPUS_UNIVERSAL;
case 2: return CORPUS_WEB;
case 3: return CORPUS_IMAGES;
case 4: return CORPUS_LOCAL;
case 5: return CORPUS_NEWS;
case 6: return CORPUS_PRODUCTS;
case 7: return CORPUS_VIDEO;
default: return null;
}
}
public static com.google.protobuf.Internal.EnumLiteMap<Corpus>
internalGetValueMap() {
return internalValueMap;
}
private static final com.google.protobuf.Internal.EnumLiteMap<
Corpus> internalValueMap =
new com.google.protobuf.Internal.EnumLiteMap<Corpus>() {
public Corpus findValueByNumber(int number) {
return Corpus.forNumber(number);
}
};
public final com.google.protobuf.Descriptors.EnumValueDescriptor
getValueDescriptor() {
if (this == UNRECOGNIZED) {
throw new java.lang.IllegalStateException(
"Can't get the descriptor of an unrecognized enum value.");
}
return getDescriptor().getValues().get(ordinal());
}
public final com.google.protobuf.Descriptors.EnumDescriptor
getDescriptorForType() {
return getDescriptor();
}
public static final com.google.protobuf.Descriptors.EnumDescriptor
getDescriptor() {
return io.bkbn.kompendium.protobufjavaconverter.Test.getDescriptor().getEnumTypes().get(0);
}
private static final Corpus[] VALUES = values();
public static Corpus valueOf(
com.google.protobuf.Descriptors.EnumValueDescriptor desc) {
if (desc.getType() != getDescriptor()) {
throw new java.lang.IllegalArgumentException(
"EnumValueDescriptor is not for this type.");
}
if (desc.getIndex() == -1) {
return UNRECOGNIZED;
}
return VALUES[desc.getIndex()];
}
private final int value;
private Corpus(int value) {
this.value = value;
}
// @@protoc_insertion_point(enum_scope:io.bkbn.kompendium.protobufjavaconverter.Corpus)
}

View File

@ -0,0 +1,607 @@
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: io/bkbn/kompendium/protobufjavaconverter/converters/test.proto
package io.bkbn.kompendium.protobufjavaconverter;
/**
* Protobuf type {@code io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage}
*/
public final class DoubleNestedMessage extends
com.google.protobuf.GeneratedMessageV3 implements
// @@protoc_insertion_point(message_implements:io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage)
DoubleNestedMessageOrBuilder {
private static final long serialVersionUID = 0L;
// Use DoubleNestedMessage.newBuilder() to construct.
private DoubleNestedMessage(com.google.protobuf.GeneratedMessageV3.Builder<?> builder) {
super(builder);
}
private DoubleNestedMessage() {
}
@java.lang.Override
@SuppressWarnings({"unused"})
protected java.lang.Object newInstance(
UnusedPrivateParameter unused) {
return new DoubleNestedMessage();
}
@java.lang.Override
public final com.google.protobuf.UnknownFieldSet
getUnknownFields() {
return this.unknownFields;
}
private DoubleNestedMessage(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
this();
if (extensionRegistry == null) {
throw new java.lang.NullPointerException();
}
com.google.protobuf.UnknownFieldSet.Builder unknownFields =
com.google.protobuf.UnknownFieldSet.newBuilder();
try {
boolean done = false;
while (!done) {
int tag = input.readTag();
switch (tag) {
case 0:
done = true;
break;
case 10: {
io.bkbn.kompendium.protobufjavaconverter.NestedMessage.Builder subBuilder = null;
if (nestedField_ != null) {
subBuilder = nestedField_.toBuilder();
}
nestedField_ = input.readMessage(io.bkbn.kompendium.protobufjavaconverter.NestedMessage.parser(), extensionRegistry);
if (subBuilder != null) {
subBuilder.mergeFrom(nestedField_);
nestedField_ = subBuilder.buildPartial();
}
break;
}
default: {
if (!parseUnknownField(
input, unknownFields, extensionRegistry, tag)) {
done = true;
}
break;
}
}
}
} catch (com.google.protobuf.InvalidProtocolBufferException e) {
throw e.setUnfinishedMessage(this);
} catch (java.io.IOException e) {
throw new com.google.protobuf.InvalidProtocolBufferException(
e).setUnfinishedMessage(this);
} finally {
this.unknownFields = unknownFields.build();
makeExtensionsImmutable();
}
}
public static final com.google.protobuf.Descriptors.Descriptor
getDescriptor() {
return io.bkbn.kompendium.protobufjavaconverter.Test.internal_static_io_bkbn_kompendium_protobufjavaconverter_DoubleNestedMessage_descriptor;
}
@java.lang.Override
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable() {
return io.bkbn.kompendium.protobufjavaconverter.Test.internal_static_io_bkbn_kompendium_protobufjavaconverter_DoubleNestedMessage_fieldAccessorTable
.ensureFieldAccessorsInitialized(
io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage.class, io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage.Builder.class);
}
public static final int NESTED_FIELD_FIELD_NUMBER = 1;
private io.bkbn.kompendium.protobufjavaconverter.NestedMessage nestedField_;
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.NestedMessage nested_field = 1;</code>
* @return Whether the nestedField field is set.
*/
@java.lang.Override
public boolean hasNestedField() {
return nestedField_ != null;
}
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.NestedMessage nested_field = 1;</code>
* @return The nestedField.
*/
@java.lang.Override
public io.bkbn.kompendium.protobufjavaconverter.NestedMessage getNestedField() {
return nestedField_ == null ? io.bkbn.kompendium.protobufjavaconverter.NestedMessage.getDefaultInstance() : nestedField_;
}
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.NestedMessage nested_field = 1;</code>
*/
@java.lang.Override
public io.bkbn.kompendium.protobufjavaconverter.NestedMessageOrBuilder getNestedFieldOrBuilder() {
return getNestedField();
}
private byte memoizedIsInitialized = -1;
@java.lang.Override
public final boolean isInitialized() {
byte isInitialized = memoizedIsInitialized;
if (isInitialized == 1) return true;
if (isInitialized == 0) return false;
memoizedIsInitialized = 1;
return true;
}
@java.lang.Override
public void writeTo(com.google.protobuf.CodedOutputStream output)
throws java.io.IOException {
if (nestedField_ != null) {
output.writeMessage(1, getNestedField());
}
unknownFields.writeTo(output);
}
@java.lang.Override
public int getSerializedSize() {
int size = memoizedSize;
if (size != -1) return size;
size = 0;
if (nestedField_ != null) {
size += com.google.protobuf.CodedOutputStream
.computeMessageSize(1, getNestedField());
}
size += unknownFields.getSerializedSize();
memoizedSize = size;
return size;
}
@java.lang.Override
public boolean equals(final java.lang.Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage)) {
return super.equals(obj);
}
io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage other = (io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage) obj;
if (hasNestedField() != other.hasNestedField()) return false;
if (hasNestedField()) {
if (!getNestedField()
.equals(other.getNestedField())) return false;
}
if (!unknownFields.equals(other.unknownFields)) return false;
return true;
}
@java.lang.Override
public int hashCode() {
if (memoizedHashCode != 0) {
return memoizedHashCode;
}
int hash = 41;
hash = (19 * hash) + getDescriptor().hashCode();
if (hasNestedField()) {
hash = (37 * hash) + NESTED_FIELD_FIELD_NUMBER;
hash = (53 * hash) + getNestedField().hashCode();
}
hash = (29 * hash) + unknownFields.hashCode();
memoizedHashCode = hash;
return hash;
}
public static io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage parseFrom(
java.nio.ByteBuffer data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage parseFrom(
java.nio.ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage parseFrom(
com.google.protobuf.ByteString data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage parseFrom(
com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage parseFrom(byte[] data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage parseFrom(
byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage parseFrom(java.io.InputStream input)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input);
}
public static io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage parseFrom(
java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input, extensionRegistry);
}
public static io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage parseDelimitedFrom(java.io.InputStream input)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseDelimitedWithIOException(PARSER, input);
}
public static io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage parseDelimitedFrom(
java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseDelimitedWithIOException(PARSER, input, extensionRegistry);
}
public static io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage parseFrom(
com.google.protobuf.CodedInputStream input)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input);
}
public static io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage parseFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input, extensionRegistry);
}
@java.lang.Override
public Builder newBuilderForType() { return newBuilder(); }
public static Builder newBuilder() {
return DEFAULT_INSTANCE.toBuilder();
}
public static Builder newBuilder(io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage prototype) {
return DEFAULT_INSTANCE.toBuilder().mergeFrom(prototype);
}
@java.lang.Override
public Builder toBuilder() {
return this == DEFAULT_INSTANCE
? new Builder() : new Builder().mergeFrom(this);
}
@java.lang.Override
protected Builder newBuilderForType(
com.google.protobuf.GeneratedMessageV3.BuilderParent parent) {
Builder builder = new Builder(parent);
return builder;
}
/**
* Protobuf type {@code io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage}
*/
public static final class Builder extends
com.google.protobuf.GeneratedMessageV3.Builder<Builder> implements
// @@protoc_insertion_point(builder_implements:io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage)
io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessageOrBuilder {
public static final com.google.protobuf.Descriptors.Descriptor
getDescriptor() {
return io.bkbn.kompendium.protobufjavaconverter.Test.internal_static_io_bkbn_kompendium_protobufjavaconverter_DoubleNestedMessage_descriptor;
}
@java.lang.Override
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable() {
return io.bkbn.kompendium.protobufjavaconverter.Test.internal_static_io_bkbn_kompendium_protobufjavaconverter_DoubleNestedMessage_fieldAccessorTable
.ensureFieldAccessorsInitialized(
io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage.class, io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage.Builder.class);
}
// Construct using io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage.newBuilder()
private Builder() {
maybeForceBuilderInitialization();
}
private Builder(
com.google.protobuf.GeneratedMessageV3.BuilderParent parent) {
super(parent);
maybeForceBuilderInitialization();
}
private void maybeForceBuilderInitialization() {
if (com.google.protobuf.GeneratedMessageV3
.alwaysUseFieldBuilders) {
}
}
@java.lang.Override
public Builder clear() {
super.clear();
if (nestedFieldBuilder_ == null) {
nestedField_ = null;
} else {
nestedField_ = null;
nestedFieldBuilder_ = null;
}
return this;
}
@java.lang.Override
public com.google.protobuf.Descriptors.Descriptor
getDescriptorForType() {
return io.bkbn.kompendium.protobufjavaconverter.Test.internal_static_io_bkbn_kompendium_protobufjavaconverter_DoubleNestedMessage_descriptor;
}
@java.lang.Override
public io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage getDefaultInstanceForType() {
return io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage.getDefaultInstance();
}
@java.lang.Override
public io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage build() {
io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage result = buildPartial();
if (!result.isInitialized()) {
throw newUninitializedMessageException(result);
}
return result;
}
@java.lang.Override
public io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage buildPartial() {
io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage result = new io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage(this);
if (nestedFieldBuilder_ == null) {
result.nestedField_ = nestedField_;
} else {
result.nestedField_ = nestedFieldBuilder_.build();
}
onBuilt();
return result;
}
@java.lang.Override
public Builder clone() {
return super.clone();
}
@java.lang.Override
public Builder setField(
com.google.protobuf.Descriptors.FieldDescriptor field,
java.lang.Object value) {
return super.setField(field, value);
}
@java.lang.Override
public Builder clearField(
com.google.protobuf.Descriptors.FieldDescriptor field) {
return super.clearField(field);
}
@java.lang.Override
public Builder clearOneof(
com.google.protobuf.Descriptors.OneofDescriptor oneof) {
return super.clearOneof(oneof);
}
@java.lang.Override
public Builder setRepeatedField(
com.google.protobuf.Descriptors.FieldDescriptor field,
int index, java.lang.Object value) {
return super.setRepeatedField(field, index, value);
}
@java.lang.Override
public Builder addRepeatedField(
com.google.protobuf.Descriptors.FieldDescriptor field,
java.lang.Object value) {
return super.addRepeatedField(field, value);
}
@java.lang.Override
public Builder mergeFrom(com.google.protobuf.Message other) {
if (other instanceof io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage) {
return mergeFrom((io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage)other);
} else {
super.mergeFrom(other);
return this;
}
}
public Builder mergeFrom(io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage other) {
if (other == io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage.getDefaultInstance()) return this;
if (other.hasNestedField()) {
mergeNestedField(other.getNestedField());
}
this.mergeUnknownFields(other.unknownFields);
onChanged();
return this;
}
@java.lang.Override
public final boolean isInitialized() {
return true;
}
@java.lang.Override
public Builder mergeFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage parsedMessage = null;
try {
parsedMessage = PARSER.parsePartialFrom(input, extensionRegistry);
} catch (com.google.protobuf.InvalidProtocolBufferException e) {
parsedMessage = (io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage) e.getUnfinishedMessage();
throw e.unwrapIOException();
} finally {
if (parsedMessage != null) {
mergeFrom(parsedMessage);
}
}
return this;
}
private io.bkbn.kompendium.protobufjavaconverter.NestedMessage nestedField_;
private com.google.protobuf.SingleFieldBuilderV3<
io.bkbn.kompendium.protobufjavaconverter.NestedMessage, io.bkbn.kompendium.protobufjavaconverter.NestedMessage.Builder, io.bkbn.kompendium.protobufjavaconverter.NestedMessageOrBuilder> nestedFieldBuilder_;
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.NestedMessage nested_field = 1;</code>
* @return Whether the nestedField field is set.
*/
public boolean hasNestedField() {
return nestedFieldBuilder_ != null || nestedField_ != null;
}
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.NestedMessage nested_field = 1;</code>
* @return The nestedField.
*/
public io.bkbn.kompendium.protobufjavaconverter.NestedMessage getNestedField() {
if (nestedFieldBuilder_ == null) {
return nestedField_ == null ? io.bkbn.kompendium.protobufjavaconverter.NestedMessage.getDefaultInstance() : nestedField_;
} else {
return nestedFieldBuilder_.getMessage();
}
}
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.NestedMessage nested_field = 1;</code>
*/
public Builder setNestedField(io.bkbn.kompendium.protobufjavaconverter.NestedMessage value) {
if (nestedFieldBuilder_ == null) {
if (value == null) {
throw new NullPointerException();
}
nestedField_ = value;
onChanged();
} else {
nestedFieldBuilder_.setMessage(value);
}
return this;
}
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.NestedMessage nested_field = 1;</code>
*/
public Builder setNestedField(
io.bkbn.kompendium.protobufjavaconverter.NestedMessage.Builder builderForValue) {
if (nestedFieldBuilder_ == null) {
nestedField_ = builderForValue.build();
onChanged();
} else {
nestedFieldBuilder_.setMessage(builderForValue.build());
}
return this;
}
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.NestedMessage nested_field = 1;</code>
*/
public Builder mergeNestedField(io.bkbn.kompendium.protobufjavaconverter.NestedMessage value) {
if (nestedFieldBuilder_ == null) {
if (nestedField_ != null) {
nestedField_ =
io.bkbn.kompendium.protobufjavaconverter.NestedMessage.newBuilder(nestedField_).mergeFrom(value).buildPartial();
} else {
nestedField_ = value;
}
onChanged();
} else {
nestedFieldBuilder_.mergeFrom(value);
}
return this;
}
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.NestedMessage nested_field = 1;</code>
*/
public Builder clearNestedField() {
if (nestedFieldBuilder_ == null) {
nestedField_ = null;
onChanged();
} else {
nestedField_ = null;
nestedFieldBuilder_ = null;
}
return this;
}
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.NestedMessage nested_field = 1;</code>
*/
public io.bkbn.kompendium.protobufjavaconverter.NestedMessage.Builder getNestedFieldBuilder() {
onChanged();
return getNestedFieldFieldBuilder().getBuilder();
}
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.NestedMessage nested_field = 1;</code>
*/
public io.bkbn.kompendium.protobufjavaconverter.NestedMessageOrBuilder getNestedFieldOrBuilder() {
if (nestedFieldBuilder_ != null) {
return nestedFieldBuilder_.getMessageOrBuilder();
} else {
return nestedField_ == null ?
io.bkbn.kompendium.protobufjavaconverter.NestedMessage.getDefaultInstance() : nestedField_;
}
}
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.NestedMessage nested_field = 1;</code>
*/
private com.google.protobuf.SingleFieldBuilderV3<
io.bkbn.kompendium.protobufjavaconverter.NestedMessage, io.bkbn.kompendium.protobufjavaconverter.NestedMessage.Builder, io.bkbn.kompendium.protobufjavaconverter.NestedMessageOrBuilder>
getNestedFieldFieldBuilder() {
if (nestedFieldBuilder_ == null) {
nestedFieldBuilder_ = new com.google.protobuf.SingleFieldBuilderV3<
io.bkbn.kompendium.protobufjavaconverter.NestedMessage, io.bkbn.kompendium.protobufjavaconverter.NestedMessage.Builder, io.bkbn.kompendium.protobufjavaconverter.NestedMessageOrBuilder>(
getNestedField(),
getParentForChildren(),
isClean());
nestedField_ = null;
}
return nestedFieldBuilder_;
}
@java.lang.Override
public final Builder setUnknownFields(
final com.google.protobuf.UnknownFieldSet unknownFields) {
return super.setUnknownFields(unknownFields);
}
@java.lang.Override
public final Builder mergeUnknownFields(
final com.google.protobuf.UnknownFieldSet unknownFields) {
return super.mergeUnknownFields(unknownFields);
}
// @@protoc_insertion_point(builder_scope:io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage)
}
// @@protoc_insertion_point(class_scope:io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage)
private static final io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage DEFAULT_INSTANCE;
static {
DEFAULT_INSTANCE = new io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage();
}
public static io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage getDefaultInstance() {
return DEFAULT_INSTANCE;
}
private static final com.google.protobuf.Parser<DoubleNestedMessage>
PARSER = new com.google.protobuf.AbstractParser<DoubleNestedMessage>() {
@java.lang.Override
public DoubleNestedMessage parsePartialFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return new DoubleNestedMessage(input, extensionRegistry);
}
};
public static com.google.protobuf.Parser<DoubleNestedMessage> parser() {
return PARSER;
}
@java.lang.Override
public com.google.protobuf.Parser<DoubleNestedMessage> getParserForType() {
return PARSER;
}
@java.lang.Override
public io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage getDefaultInstanceForType() {
return DEFAULT_INSTANCE;
}
}

View File

@ -0,0 +1,24 @@
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: io/bkbn/kompendium/protobufjavaconverter/converters/test.proto
package io.bkbn.kompendium.protobufjavaconverter;
public interface DoubleNestedMessageOrBuilder extends
// @@protoc_insertion_point(interface_extends:io.bkbn.kompendium.protobufjavaconverter.DoubleNestedMessage)
com.google.protobuf.MessageOrBuilder {
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.NestedMessage nested_field = 1;</code>
* @return Whether the nestedField field is set.
*/
boolean hasNestedField();
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.NestedMessage nested_field = 1;</code>
* @return The nestedField.
*/
io.bkbn.kompendium.protobufjavaconverter.NestedMessage getNestedField();
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.NestedMessage nested_field = 1;</code>
*/
io.bkbn.kompendium.protobufjavaconverter.NestedMessageOrBuilder getNestedFieldOrBuilder();
}

View File

@ -0,0 +1,515 @@
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: io/bkbn/kompendium/protobufjavaconverter/converters/test.proto
package io.bkbn.kompendium.protobufjavaconverter;
/**
* Protobuf type {@code io.bkbn.kompendium.protobufjavaconverter.EnumMessage}
*/
public final class EnumMessage extends
com.google.protobuf.GeneratedMessageV3 implements
// @@protoc_insertion_point(message_implements:io.bkbn.kompendium.protobufjavaconverter.EnumMessage)
EnumMessageOrBuilder {
private static final long serialVersionUID = 0L;
// Use EnumMessage.newBuilder() to construct.
private EnumMessage(com.google.protobuf.GeneratedMessageV3.Builder<?> builder) {
super(builder);
}
private EnumMessage() {
corpus_ = 0;
}
@java.lang.Override
@SuppressWarnings({"unused"})
protected java.lang.Object newInstance(
UnusedPrivateParameter unused) {
return new EnumMessage();
}
@java.lang.Override
public final com.google.protobuf.UnknownFieldSet
getUnknownFields() {
return this.unknownFields;
}
private EnumMessage(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
this();
if (extensionRegistry == null) {
throw new java.lang.NullPointerException();
}
com.google.protobuf.UnknownFieldSet.Builder unknownFields =
com.google.protobuf.UnknownFieldSet.newBuilder();
try {
boolean done = false;
while (!done) {
int tag = input.readTag();
switch (tag) {
case 0:
done = true;
break;
case 8: {
int rawValue = input.readEnum();
corpus_ = rawValue;
break;
}
default: {
if (!parseUnknownField(
input, unknownFields, extensionRegistry, tag)) {
done = true;
}
break;
}
}
}
} catch (com.google.protobuf.InvalidProtocolBufferException e) {
throw e.setUnfinishedMessage(this);
} catch (java.io.IOException e) {
throw new com.google.protobuf.InvalidProtocolBufferException(
e).setUnfinishedMessage(this);
} finally {
this.unknownFields = unknownFields.build();
makeExtensionsImmutable();
}
}
public static final com.google.protobuf.Descriptors.Descriptor
getDescriptor() {
return io.bkbn.kompendium.protobufjavaconverter.Test.internal_static_io_bkbn_kompendium_protobufjavaconverter_EnumMessage_descriptor;
}
@java.lang.Override
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable() {
return io.bkbn.kompendium.protobufjavaconverter.Test.internal_static_io_bkbn_kompendium_protobufjavaconverter_EnumMessage_fieldAccessorTable
.ensureFieldAccessorsInitialized(
io.bkbn.kompendium.protobufjavaconverter.EnumMessage.class, io.bkbn.kompendium.protobufjavaconverter.EnumMessage.Builder.class);
}
public static final int CORPUS_FIELD_NUMBER = 1;
private int corpus_;
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.Corpus corpus = 1;</code>
* @return The enum numeric value on the wire for corpus.
*/
@java.lang.Override public int getCorpusValue() {
return corpus_;
}
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.Corpus corpus = 1;</code>
* @return The corpus.
*/
@java.lang.Override public io.bkbn.kompendium.protobufjavaconverter.Corpus getCorpus() {
@SuppressWarnings("deprecation")
io.bkbn.kompendium.protobufjavaconverter.Corpus result = io.bkbn.kompendium.protobufjavaconverter.Corpus.valueOf(corpus_);
return result == null ? io.bkbn.kompendium.protobufjavaconverter.Corpus.UNRECOGNIZED : result;
}
private byte memoizedIsInitialized = -1;
@java.lang.Override
public final boolean isInitialized() {
byte isInitialized = memoizedIsInitialized;
if (isInitialized == 1) return true;
if (isInitialized == 0) return false;
memoizedIsInitialized = 1;
return true;
}
@java.lang.Override
public void writeTo(com.google.protobuf.CodedOutputStream output)
throws java.io.IOException {
if (corpus_ != io.bkbn.kompendium.protobufjavaconverter.Corpus.CORPUS_UNSPECIFIED.getNumber()) {
output.writeEnum(1, corpus_);
}
unknownFields.writeTo(output);
}
@java.lang.Override
public int getSerializedSize() {
int size = memoizedSize;
if (size != -1) return size;
size = 0;
if (corpus_ != io.bkbn.kompendium.protobufjavaconverter.Corpus.CORPUS_UNSPECIFIED.getNumber()) {
size += com.google.protobuf.CodedOutputStream
.computeEnumSize(1, corpus_);
}
size += unknownFields.getSerializedSize();
memoizedSize = size;
return size;
}
@java.lang.Override
public boolean equals(final java.lang.Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof io.bkbn.kompendium.protobufjavaconverter.EnumMessage)) {
return super.equals(obj);
}
io.bkbn.kompendium.protobufjavaconverter.EnumMessage other = (io.bkbn.kompendium.protobufjavaconverter.EnumMessage) obj;
if (corpus_ != other.corpus_) return false;
if (!unknownFields.equals(other.unknownFields)) return false;
return true;
}
@java.lang.Override
public int hashCode() {
if (memoizedHashCode != 0) {
return memoizedHashCode;
}
int hash = 41;
hash = (19 * hash) + getDescriptor().hashCode();
hash = (37 * hash) + CORPUS_FIELD_NUMBER;
hash = (53 * hash) + corpus_;
hash = (29 * hash) + unknownFields.hashCode();
memoizedHashCode = hash;
return hash;
}
public static io.bkbn.kompendium.protobufjavaconverter.EnumMessage parseFrom(
java.nio.ByteBuffer data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static io.bkbn.kompendium.protobufjavaconverter.EnumMessage parseFrom(
java.nio.ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static io.bkbn.kompendium.protobufjavaconverter.EnumMessage parseFrom(
com.google.protobuf.ByteString data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static io.bkbn.kompendium.protobufjavaconverter.EnumMessage parseFrom(
com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static io.bkbn.kompendium.protobufjavaconverter.EnumMessage parseFrom(byte[] data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static io.bkbn.kompendium.protobufjavaconverter.EnumMessage parseFrom(
byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static io.bkbn.kompendium.protobufjavaconverter.EnumMessage parseFrom(java.io.InputStream input)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input);
}
public static io.bkbn.kompendium.protobufjavaconverter.EnumMessage parseFrom(
java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input, extensionRegistry);
}
public static io.bkbn.kompendium.protobufjavaconverter.EnumMessage parseDelimitedFrom(java.io.InputStream input)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseDelimitedWithIOException(PARSER, input);
}
public static io.bkbn.kompendium.protobufjavaconverter.EnumMessage parseDelimitedFrom(
java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseDelimitedWithIOException(PARSER, input, extensionRegistry);
}
public static io.bkbn.kompendium.protobufjavaconverter.EnumMessage parseFrom(
com.google.protobuf.CodedInputStream input)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input);
}
public static io.bkbn.kompendium.protobufjavaconverter.EnumMessage parseFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input, extensionRegistry);
}
@java.lang.Override
public Builder newBuilderForType() { return newBuilder(); }
public static Builder newBuilder() {
return DEFAULT_INSTANCE.toBuilder();
}
public static Builder newBuilder(io.bkbn.kompendium.protobufjavaconverter.EnumMessage prototype) {
return DEFAULT_INSTANCE.toBuilder().mergeFrom(prototype);
}
@java.lang.Override
public Builder toBuilder() {
return this == DEFAULT_INSTANCE
? new Builder() : new Builder().mergeFrom(this);
}
@java.lang.Override
protected Builder newBuilderForType(
com.google.protobuf.GeneratedMessageV3.BuilderParent parent) {
Builder builder = new Builder(parent);
return builder;
}
/**
* Protobuf type {@code io.bkbn.kompendium.protobufjavaconverter.EnumMessage}
*/
public static final class Builder extends
com.google.protobuf.GeneratedMessageV3.Builder<Builder> implements
// @@protoc_insertion_point(builder_implements:io.bkbn.kompendium.protobufjavaconverter.EnumMessage)
io.bkbn.kompendium.protobufjavaconverter.EnumMessageOrBuilder {
public static final com.google.protobuf.Descriptors.Descriptor
getDescriptor() {
return io.bkbn.kompendium.protobufjavaconverter.Test.internal_static_io_bkbn_kompendium_protobufjavaconverter_EnumMessage_descriptor;
}
@java.lang.Override
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable() {
return io.bkbn.kompendium.protobufjavaconverter.Test.internal_static_io_bkbn_kompendium_protobufjavaconverter_EnumMessage_fieldAccessorTable
.ensureFieldAccessorsInitialized(
io.bkbn.kompendium.protobufjavaconverter.EnumMessage.class, io.bkbn.kompendium.protobufjavaconverter.EnumMessage.Builder.class);
}
// Construct using io.bkbn.kompendium.protobufjavaconverter.EnumMessage.newBuilder()
private Builder() {
maybeForceBuilderInitialization();
}
private Builder(
com.google.protobuf.GeneratedMessageV3.BuilderParent parent) {
super(parent);
maybeForceBuilderInitialization();
}
private void maybeForceBuilderInitialization() {
if (com.google.protobuf.GeneratedMessageV3
.alwaysUseFieldBuilders) {
}
}
@java.lang.Override
public Builder clear() {
super.clear();
corpus_ = 0;
return this;
}
@java.lang.Override
public com.google.protobuf.Descriptors.Descriptor
getDescriptorForType() {
return io.bkbn.kompendium.protobufjavaconverter.Test.internal_static_io_bkbn_kompendium_protobufjavaconverter_EnumMessage_descriptor;
}
@java.lang.Override
public io.bkbn.kompendium.protobufjavaconverter.EnumMessage getDefaultInstanceForType() {
return io.bkbn.kompendium.protobufjavaconverter.EnumMessage.getDefaultInstance();
}
@java.lang.Override
public io.bkbn.kompendium.protobufjavaconverter.EnumMessage build() {
io.bkbn.kompendium.protobufjavaconverter.EnumMessage result = buildPartial();
if (!result.isInitialized()) {
throw newUninitializedMessageException(result);
}
return result;
}
@java.lang.Override
public io.bkbn.kompendium.protobufjavaconverter.EnumMessage buildPartial() {
io.bkbn.kompendium.protobufjavaconverter.EnumMessage result = new io.bkbn.kompendium.protobufjavaconverter.EnumMessage(this);
result.corpus_ = corpus_;
onBuilt();
return result;
}
@java.lang.Override
public Builder clone() {
return super.clone();
}
@java.lang.Override
public Builder setField(
com.google.protobuf.Descriptors.FieldDescriptor field,
java.lang.Object value) {
return super.setField(field, value);
}
@java.lang.Override
public Builder clearField(
com.google.protobuf.Descriptors.FieldDescriptor field) {
return super.clearField(field);
}
@java.lang.Override
public Builder clearOneof(
com.google.protobuf.Descriptors.OneofDescriptor oneof) {
return super.clearOneof(oneof);
}
@java.lang.Override
public Builder setRepeatedField(
com.google.protobuf.Descriptors.FieldDescriptor field,
int index, java.lang.Object value) {
return super.setRepeatedField(field, index, value);
}
@java.lang.Override
public Builder addRepeatedField(
com.google.protobuf.Descriptors.FieldDescriptor field,
java.lang.Object value) {
return super.addRepeatedField(field, value);
}
@java.lang.Override
public Builder mergeFrom(com.google.protobuf.Message other) {
if (other instanceof io.bkbn.kompendium.protobufjavaconverter.EnumMessage) {
return mergeFrom((io.bkbn.kompendium.protobufjavaconverter.EnumMessage)other);
} else {
super.mergeFrom(other);
return this;
}
}
public Builder mergeFrom(io.bkbn.kompendium.protobufjavaconverter.EnumMessage other) {
if (other == io.bkbn.kompendium.protobufjavaconverter.EnumMessage.getDefaultInstance()) return this;
if (other.corpus_ != 0) {
setCorpusValue(other.getCorpusValue());
}
this.mergeUnknownFields(other.unknownFields);
onChanged();
return this;
}
@java.lang.Override
public final boolean isInitialized() {
return true;
}
@java.lang.Override
public Builder mergeFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
io.bkbn.kompendium.protobufjavaconverter.EnumMessage parsedMessage = null;
try {
parsedMessage = PARSER.parsePartialFrom(input, extensionRegistry);
} catch (com.google.protobuf.InvalidProtocolBufferException e) {
parsedMessage = (io.bkbn.kompendium.protobufjavaconverter.EnumMessage) e.getUnfinishedMessage();
throw e.unwrapIOException();
} finally {
if (parsedMessage != null) {
mergeFrom(parsedMessage);
}
}
return this;
}
private int corpus_ = 0;
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.Corpus corpus = 1;</code>
* @return The enum numeric value on the wire for corpus.
*/
@java.lang.Override public int getCorpusValue() {
return corpus_;
}
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.Corpus corpus = 1;</code>
* @param value The enum numeric value on the wire for corpus to set.
* @return This builder for chaining.
*/
public Builder setCorpusValue(int value) {
corpus_ = value;
onChanged();
return this;
}
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.Corpus corpus = 1;</code>
* @return The corpus.
*/
@java.lang.Override
public io.bkbn.kompendium.protobufjavaconverter.Corpus getCorpus() {
@SuppressWarnings("deprecation")
io.bkbn.kompendium.protobufjavaconverter.Corpus result = io.bkbn.kompendium.protobufjavaconverter.Corpus.valueOf(corpus_);
return result == null ? io.bkbn.kompendium.protobufjavaconverter.Corpus.UNRECOGNIZED : result;
}
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.Corpus corpus = 1;</code>
* @param value The corpus to set.
* @return This builder for chaining.
*/
public Builder setCorpus(io.bkbn.kompendium.protobufjavaconverter.Corpus value) {
if (value == null) {
throw new NullPointerException();
}
corpus_ = value.getNumber();
onChanged();
return this;
}
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.Corpus corpus = 1;</code>
* @return This builder for chaining.
*/
public Builder clearCorpus() {
corpus_ = 0;
onChanged();
return this;
}
@java.lang.Override
public final Builder setUnknownFields(
final com.google.protobuf.UnknownFieldSet unknownFields) {
return super.setUnknownFields(unknownFields);
}
@java.lang.Override
public final Builder mergeUnknownFields(
final com.google.protobuf.UnknownFieldSet unknownFields) {
return super.mergeUnknownFields(unknownFields);
}
// @@protoc_insertion_point(builder_scope:io.bkbn.kompendium.protobufjavaconverter.EnumMessage)
}
// @@protoc_insertion_point(class_scope:io.bkbn.kompendium.protobufjavaconverter.EnumMessage)
private static final io.bkbn.kompendium.protobufjavaconverter.EnumMessage DEFAULT_INSTANCE;
static {
DEFAULT_INSTANCE = new io.bkbn.kompendium.protobufjavaconverter.EnumMessage();
}
public static io.bkbn.kompendium.protobufjavaconverter.EnumMessage getDefaultInstance() {
return DEFAULT_INSTANCE;
}
private static final com.google.protobuf.Parser<EnumMessage>
PARSER = new com.google.protobuf.AbstractParser<EnumMessage>() {
@java.lang.Override
public EnumMessage parsePartialFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return new EnumMessage(input, extensionRegistry);
}
};
public static com.google.protobuf.Parser<EnumMessage> parser() {
return PARSER;
}
@java.lang.Override
public com.google.protobuf.Parser<EnumMessage> getParserForType() {
return PARSER;
}
@java.lang.Override
public io.bkbn.kompendium.protobufjavaconverter.EnumMessage getDefaultInstanceForType() {
return DEFAULT_INSTANCE;
}
}

View File

@ -0,0 +1,20 @@
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: io/bkbn/kompendium/protobufjavaconverter/converters/test.proto
package io.bkbn.kompendium.protobufjavaconverter;
public interface EnumMessageOrBuilder extends
// @@protoc_insertion_point(interface_extends:io.bkbn.kompendium.protobufjavaconverter.EnumMessage)
com.google.protobuf.MessageOrBuilder {
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.Corpus corpus = 1;</code>
* @return The enum numeric value on the wire for corpus.
*/
int getCorpusValue();
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.Corpus corpus = 1;</code>
* @return The corpus.
*/
io.bkbn.kompendium.protobufjavaconverter.Corpus getCorpus();
}

View File

@ -0,0 +1,843 @@
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: io/bkbn/kompendium/protobufjavaconverter/converters/test.proto
package io.bkbn.kompendium.protobufjavaconverter;
/**
* Protobuf type {@code io.bkbn.kompendium.protobufjavaconverter.GoogleTypes}
*/
public final class GoogleTypes extends
com.google.protobuf.GeneratedMessageV3 implements
// @@protoc_insertion_point(message_implements:io.bkbn.kompendium.protobufjavaconverter.GoogleTypes)
GoogleTypesOrBuilder {
private static final long serialVersionUID = 0L;
// Use GoogleTypes.newBuilder() to construct.
private GoogleTypes(com.google.protobuf.GeneratedMessageV3.Builder<?> builder) {
super(builder);
}
private GoogleTypes() {
}
@java.lang.Override
@SuppressWarnings({"unused"})
protected java.lang.Object newInstance(
UnusedPrivateParameter unused) {
return new GoogleTypes();
}
@java.lang.Override
public final com.google.protobuf.UnknownFieldSet
getUnknownFields() {
return this.unknownFields;
}
private GoogleTypes(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
this();
if (extensionRegistry == null) {
throw new java.lang.NullPointerException();
}
com.google.protobuf.UnknownFieldSet.Builder unknownFields =
com.google.protobuf.UnknownFieldSet.newBuilder();
try {
boolean done = false;
while (!done) {
int tag = input.readTag();
switch (tag) {
case 0:
done = true;
break;
case 10: {
com.google.protobuf.Timestamp.Builder subBuilder = null;
if (timestampField_ != null) {
subBuilder = timestampField_.toBuilder();
}
timestampField_ = input.readMessage(com.google.protobuf.Timestamp.parser(), extensionRegistry);
if (subBuilder != null) {
subBuilder.mergeFrom(timestampField_);
timestampField_ = subBuilder.buildPartial();
}
break;
}
case 18: {
com.google.protobuf.Duration.Builder subBuilder = null;
if (durationField_ != null) {
subBuilder = durationField_.toBuilder();
}
durationField_ = input.readMessage(com.google.protobuf.Duration.parser(), extensionRegistry);
if (subBuilder != null) {
subBuilder.mergeFrom(durationField_);
durationField_ = subBuilder.buildPartial();
}
break;
}
default: {
if (!parseUnknownField(
input, unknownFields, extensionRegistry, tag)) {
done = true;
}
break;
}
}
}
} catch (com.google.protobuf.InvalidProtocolBufferException e) {
throw e.setUnfinishedMessage(this);
} catch (java.io.IOException e) {
throw new com.google.protobuf.InvalidProtocolBufferException(
e).setUnfinishedMessage(this);
} finally {
this.unknownFields = unknownFields.build();
makeExtensionsImmutable();
}
}
public static final com.google.protobuf.Descriptors.Descriptor
getDescriptor() {
return io.bkbn.kompendium.protobufjavaconverter.Test.internal_static_io_bkbn_kompendium_protobufjavaconverter_GoogleTypes_descriptor;
}
@java.lang.Override
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable() {
return io.bkbn.kompendium.protobufjavaconverter.Test.internal_static_io_bkbn_kompendium_protobufjavaconverter_GoogleTypes_fieldAccessorTable
.ensureFieldAccessorsInitialized(
io.bkbn.kompendium.protobufjavaconverter.GoogleTypes.class, io.bkbn.kompendium.protobufjavaconverter.GoogleTypes.Builder.class);
}
public static final int TIMESTAMP_FIELD_FIELD_NUMBER = 1;
private com.google.protobuf.Timestamp timestampField_;
/**
* <code>.google.protobuf.Timestamp timestamp_field = 1;</code>
* @return Whether the timestampField field is set.
*/
@java.lang.Override
public boolean hasTimestampField() {
return timestampField_ != null;
}
/**
* <code>.google.protobuf.Timestamp timestamp_field = 1;</code>
* @return The timestampField.
*/
@java.lang.Override
public com.google.protobuf.Timestamp getTimestampField() {
return timestampField_ == null ? com.google.protobuf.Timestamp.getDefaultInstance() : timestampField_;
}
/**
* <code>.google.protobuf.Timestamp timestamp_field = 1;</code>
*/
@java.lang.Override
public com.google.protobuf.TimestampOrBuilder getTimestampFieldOrBuilder() {
return getTimestampField();
}
public static final int DURATION_FIELD_FIELD_NUMBER = 2;
private com.google.protobuf.Duration durationField_;
/**
* <pre>
* TODO value types
* </pre>
*
* <code>.google.protobuf.Duration duration_field = 2;</code>
* @return Whether the durationField field is set.
*/
@java.lang.Override
public boolean hasDurationField() {
return durationField_ != null;
}
/**
* <pre>
* TODO value types
* </pre>
*
* <code>.google.protobuf.Duration duration_field = 2;</code>
* @return The durationField.
*/
@java.lang.Override
public com.google.protobuf.Duration getDurationField() {
return durationField_ == null ? com.google.protobuf.Duration.getDefaultInstance() : durationField_;
}
/**
* <pre>
* TODO value types
* </pre>
*
* <code>.google.protobuf.Duration duration_field = 2;</code>
*/
@java.lang.Override
public com.google.protobuf.DurationOrBuilder getDurationFieldOrBuilder() {
return getDurationField();
}
private byte memoizedIsInitialized = -1;
@java.lang.Override
public final boolean isInitialized() {
byte isInitialized = memoizedIsInitialized;
if (isInitialized == 1) return true;
if (isInitialized == 0) return false;
memoizedIsInitialized = 1;
return true;
}
@java.lang.Override
public void writeTo(com.google.protobuf.CodedOutputStream output)
throws java.io.IOException {
if (timestampField_ != null) {
output.writeMessage(1, getTimestampField());
}
if (durationField_ != null) {
output.writeMessage(2, getDurationField());
}
unknownFields.writeTo(output);
}
@java.lang.Override
public int getSerializedSize() {
int size = memoizedSize;
if (size != -1) return size;
size = 0;
if (timestampField_ != null) {
size += com.google.protobuf.CodedOutputStream
.computeMessageSize(1, getTimestampField());
}
if (durationField_ != null) {
size += com.google.protobuf.CodedOutputStream
.computeMessageSize(2, getDurationField());
}
size += unknownFields.getSerializedSize();
memoizedSize = size;
return size;
}
@java.lang.Override
public boolean equals(final java.lang.Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof io.bkbn.kompendium.protobufjavaconverter.GoogleTypes)) {
return super.equals(obj);
}
io.bkbn.kompendium.protobufjavaconverter.GoogleTypes other = (io.bkbn.kompendium.protobufjavaconverter.GoogleTypes) obj;
if (hasTimestampField() != other.hasTimestampField()) return false;
if (hasTimestampField()) {
if (!getTimestampField()
.equals(other.getTimestampField())) return false;
}
if (hasDurationField() != other.hasDurationField()) return false;
if (hasDurationField()) {
if (!getDurationField()
.equals(other.getDurationField())) return false;
}
if (!unknownFields.equals(other.unknownFields)) return false;
return true;
}
@java.lang.Override
public int hashCode() {
if (memoizedHashCode != 0) {
return memoizedHashCode;
}
int hash = 41;
hash = (19 * hash) + getDescriptor().hashCode();
if (hasTimestampField()) {
hash = (37 * hash) + TIMESTAMP_FIELD_FIELD_NUMBER;
hash = (53 * hash) + getTimestampField().hashCode();
}
if (hasDurationField()) {
hash = (37 * hash) + DURATION_FIELD_FIELD_NUMBER;
hash = (53 * hash) + getDurationField().hashCode();
}
hash = (29 * hash) + unknownFields.hashCode();
memoizedHashCode = hash;
return hash;
}
public static io.bkbn.kompendium.protobufjavaconverter.GoogleTypes parseFrom(
java.nio.ByteBuffer data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static io.bkbn.kompendium.protobufjavaconverter.GoogleTypes parseFrom(
java.nio.ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static io.bkbn.kompendium.protobufjavaconverter.GoogleTypes parseFrom(
com.google.protobuf.ByteString data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static io.bkbn.kompendium.protobufjavaconverter.GoogleTypes parseFrom(
com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static io.bkbn.kompendium.protobufjavaconverter.GoogleTypes parseFrom(byte[] data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static io.bkbn.kompendium.protobufjavaconverter.GoogleTypes parseFrom(
byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static io.bkbn.kompendium.protobufjavaconverter.GoogleTypes parseFrom(java.io.InputStream input)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input);
}
public static io.bkbn.kompendium.protobufjavaconverter.GoogleTypes parseFrom(
java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input, extensionRegistry);
}
public static io.bkbn.kompendium.protobufjavaconverter.GoogleTypes parseDelimitedFrom(java.io.InputStream input)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseDelimitedWithIOException(PARSER, input);
}
public static io.bkbn.kompendium.protobufjavaconverter.GoogleTypes parseDelimitedFrom(
java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseDelimitedWithIOException(PARSER, input, extensionRegistry);
}
public static io.bkbn.kompendium.protobufjavaconverter.GoogleTypes parseFrom(
com.google.protobuf.CodedInputStream input)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input);
}
public static io.bkbn.kompendium.protobufjavaconverter.GoogleTypes parseFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input, extensionRegistry);
}
@java.lang.Override
public Builder newBuilderForType() { return newBuilder(); }
public static Builder newBuilder() {
return DEFAULT_INSTANCE.toBuilder();
}
public static Builder newBuilder(io.bkbn.kompendium.protobufjavaconverter.GoogleTypes prototype) {
return DEFAULT_INSTANCE.toBuilder().mergeFrom(prototype);
}
@java.lang.Override
public Builder toBuilder() {
return this == DEFAULT_INSTANCE
? new Builder() : new Builder().mergeFrom(this);
}
@java.lang.Override
protected Builder newBuilderForType(
com.google.protobuf.GeneratedMessageV3.BuilderParent parent) {
Builder builder = new Builder(parent);
return builder;
}
/**
* Protobuf type {@code io.bkbn.kompendium.protobufjavaconverter.GoogleTypes}
*/
public static final class Builder extends
com.google.protobuf.GeneratedMessageV3.Builder<Builder> implements
// @@protoc_insertion_point(builder_implements:io.bkbn.kompendium.protobufjavaconverter.GoogleTypes)
io.bkbn.kompendium.protobufjavaconverter.GoogleTypesOrBuilder {
public static final com.google.protobuf.Descriptors.Descriptor
getDescriptor() {
return io.bkbn.kompendium.protobufjavaconverter.Test.internal_static_io_bkbn_kompendium_protobufjavaconverter_GoogleTypes_descriptor;
}
@java.lang.Override
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable() {
return io.bkbn.kompendium.protobufjavaconverter.Test.internal_static_io_bkbn_kompendium_protobufjavaconverter_GoogleTypes_fieldAccessorTable
.ensureFieldAccessorsInitialized(
io.bkbn.kompendium.protobufjavaconverter.GoogleTypes.class, io.bkbn.kompendium.protobufjavaconverter.GoogleTypes.Builder.class);
}
// Construct using io.bkbn.kompendium.protobufjavaconverter.GoogleTypes.newBuilder()
private Builder() {
maybeForceBuilderInitialization();
}
private Builder(
com.google.protobuf.GeneratedMessageV3.BuilderParent parent) {
super(parent);
maybeForceBuilderInitialization();
}
private void maybeForceBuilderInitialization() {
if (com.google.protobuf.GeneratedMessageV3
.alwaysUseFieldBuilders) {
}
}
@java.lang.Override
public Builder clear() {
super.clear();
if (timestampFieldBuilder_ == null) {
timestampField_ = null;
} else {
timestampField_ = null;
timestampFieldBuilder_ = null;
}
if (durationFieldBuilder_ == null) {
durationField_ = null;
} else {
durationField_ = null;
durationFieldBuilder_ = null;
}
return this;
}
@java.lang.Override
public com.google.protobuf.Descriptors.Descriptor
getDescriptorForType() {
return io.bkbn.kompendium.protobufjavaconverter.Test.internal_static_io_bkbn_kompendium_protobufjavaconverter_GoogleTypes_descriptor;
}
@java.lang.Override
public io.bkbn.kompendium.protobufjavaconverter.GoogleTypes getDefaultInstanceForType() {
return io.bkbn.kompendium.protobufjavaconverter.GoogleTypes.getDefaultInstance();
}
@java.lang.Override
public io.bkbn.kompendium.protobufjavaconverter.GoogleTypes build() {
io.bkbn.kompendium.protobufjavaconverter.GoogleTypes result = buildPartial();
if (!result.isInitialized()) {
throw newUninitializedMessageException(result);
}
return result;
}
@java.lang.Override
public io.bkbn.kompendium.protobufjavaconverter.GoogleTypes buildPartial() {
io.bkbn.kompendium.protobufjavaconverter.GoogleTypes result = new io.bkbn.kompendium.protobufjavaconverter.GoogleTypes(this);
if (timestampFieldBuilder_ == null) {
result.timestampField_ = timestampField_;
} else {
result.timestampField_ = timestampFieldBuilder_.build();
}
if (durationFieldBuilder_ == null) {
result.durationField_ = durationField_;
} else {
result.durationField_ = durationFieldBuilder_.build();
}
onBuilt();
return result;
}
@java.lang.Override
public Builder clone() {
return super.clone();
}
@java.lang.Override
public Builder setField(
com.google.protobuf.Descriptors.FieldDescriptor field,
java.lang.Object value) {
return super.setField(field, value);
}
@java.lang.Override
public Builder clearField(
com.google.protobuf.Descriptors.FieldDescriptor field) {
return super.clearField(field);
}
@java.lang.Override
public Builder clearOneof(
com.google.protobuf.Descriptors.OneofDescriptor oneof) {
return super.clearOneof(oneof);
}
@java.lang.Override
public Builder setRepeatedField(
com.google.protobuf.Descriptors.FieldDescriptor field,
int index, java.lang.Object value) {
return super.setRepeatedField(field, index, value);
}
@java.lang.Override
public Builder addRepeatedField(
com.google.protobuf.Descriptors.FieldDescriptor field,
java.lang.Object value) {
return super.addRepeatedField(field, value);
}
@java.lang.Override
public Builder mergeFrom(com.google.protobuf.Message other) {
if (other instanceof io.bkbn.kompendium.protobufjavaconverter.GoogleTypes) {
return mergeFrom((io.bkbn.kompendium.protobufjavaconverter.GoogleTypes)other);
} else {
super.mergeFrom(other);
return this;
}
}
public Builder mergeFrom(io.bkbn.kompendium.protobufjavaconverter.GoogleTypes other) {
if (other == io.bkbn.kompendium.protobufjavaconverter.GoogleTypes.getDefaultInstance()) return this;
if (other.hasTimestampField()) {
mergeTimestampField(other.getTimestampField());
}
if (other.hasDurationField()) {
mergeDurationField(other.getDurationField());
}
this.mergeUnknownFields(other.unknownFields);
onChanged();
return this;
}
@java.lang.Override
public final boolean isInitialized() {
return true;
}
@java.lang.Override
public Builder mergeFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
io.bkbn.kompendium.protobufjavaconverter.GoogleTypes parsedMessage = null;
try {
parsedMessage = PARSER.parsePartialFrom(input, extensionRegistry);
} catch (com.google.protobuf.InvalidProtocolBufferException e) {
parsedMessage = (io.bkbn.kompendium.protobufjavaconverter.GoogleTypes) e.getUnfinishedMessage();
throw e.unwrapIOException();
} finally {
if (parsedMessage != null) {
mergeFrom(parsedMessage);
}
}
return this;
}
private com.google.protobuf.Timestamp timestampField_;
private com.google.protobuf.SingleFieldBuilderV3<
com.google.protobuf.Timestamp, com.google.protobuf.Timestamp.Builder, com.google.protobuf.TimestampOrBuilder> timestampFieldBuilder_;
/**
* <code>.google.protobuf.Timestamp timestamp_field = 1;</code>
* @return Whether the timestampField field is set.
*/
public boolean hasTimestampField() {
return timestampFieldBuilder_ != null || timestampField_ != null;
}
/**
* <code>.google.protobuf.Timestamp timestamp_field = 1;</code>
* @return The timestampField.
*/
public com.google.protobuf.Timestamp getTimestampField() {
if (timestampFieldBuilder_ == null) {
return timestampField_ == null ? com.google.protobuf.Timestamp.getDefaultInstance() : timestampField_;
} else {
return timestampFieldBuilder_.getMessage();
}
}
/**
* <code>.google.protobuf.Timestamp timestamp_field = 1;</code>
*/
public Builder setTimestampField(com.google.protobuf.Timestamp value) {
if (timestampFieldBuilder_ == null) {
if (value == null) {
throw new NullPointerException();
}
timestampField_ = value;
onChanged();
} else {
timestampFieldBuilder_.setMessage(value);
}
return this;
}
/**
* <code>.google.protobuf.Timestamp timestamp_field = 1;</code>
*/
public Builder setTimestampField(
com.google.protobuf.Timestamp.Builder builderForValue) {
if (timestampFieldBuilder_ == null) {
timestampField_ = builderForValue.build();
onChanged();
} else {
timestampFieldBuilder_.setMessage(builderForValue.build());
}
return this;
}
/**
* <code>.google.protobuf.Timestamp timestamp_field = 1;</code>
*/
public Builder mergeTimestampField(com.google.protobuf.Timestamp value) {
if (timestampFieldBuilder_ == null) {
if (timestampField_ != null) {
timestampField_ =
com.google.protobuf.Timestamp.newBuilder(timestampField_).mergeFrom(value).buildPartial();
} else {
timestampField_ = value;
}
onChanged();
} else {
timestampFieldBuilder_.mergeFrom(value);
}
return this;
}
/**
* <code>.google.protobuf.Timestamp timestamp_field = 1;</code>
*/
public Builder clearTimestampField() {
if (timestampFieldBuilder_ == null) {
timestampField_ = null;
onChanged();
} else {
timestampField_ = null;
timestampFieldBuilder_ = null;
}
return this;
}
/**
* <code>.google.protobuf.Timestamp timestamp_field = 1;</code>
*/
public com.google.protobuf.Timestamp.Builder getTimestampFieldBuilder() {
onChanged();
return getTimestampFieldFieldBuilder().getBuilder();
}
/**
* <code>.google.protobuf.Timestamp timestamp_field = 1;</code>
*/
public com.google.protobuf.TimestampOrBuilder getTimestampFieldOrBuilder() {
if (timestampFieldBuilder_ != null) {
return timestampFieldBuilder_.getMessageOrBuilder();
} else {
return timestampField_ == null ?
com.google.protobuf.Timestamp.getDefaultInstance() : timestampField_;
}
}
/**
* <code>.google.protobuf.Timestamp timestamp_field = 1;</code>
*/
private com.google.protobuf.SingleFieldBuilderV3<
com.google.protobuf.Timestamp, com.google.protobuf.Timestamp.Builder, com.google.protobuf.TimestampOrBuilder>
getTimestampFieldFieldBuilder() {
if (timestampFieldBuilder_ == null) {
timestampFieldBuilder_ = new com.google.protobuf.SingleFieldBuilderV3<
com.google.protobuf.Timestamp, com.google.protobuf.Timestamp.Builder, com.google.protobuf.TimestampOrBuilder>(
getTimestampField(),
getParentForChildren(),
isClean());
timestampField_ = null;
}
return timestampFieldBuilder_;
}
private com.google.protobuf.Duration durationField_;
private com.google.protobuf.SingleFieldBuilderV3<
com.google.protobuf.Duration, com.google.protobuf.Duration.Builder, com.google.protobuf.DurationOrBuilder> durationFieldBuilder_;
/**
* <pre>
* TODO value types
* </pre>
*
* <code>.google.protobuf.Duration duration_field = 2;</code>
* @return Whether the durationField field is set.
*/
public boolean hasDurationField() {
return durationFieldBuilder_ != null || durationField_ != null;
}
/**
* <pre>
* TODO value types
* </pre>
*
* <code>.google.protobuf.Duration duration_field = 2;</code>
* @return The durationField.
*/
public com.google.protobuf.Duration getDurationField() {
if (durationFieldBuilder_ == null) {
return durationField_ == null ? com.google.protobuf.Duration.getDefaultInstance() : durationField_;
} else {
return durationFieldBuilder_.getMessage();
}
}
/**
* <pre>
* TODO value types
* </pre>
*
* <code>.google.protobuf.Duration duration_field = 2;</code>
*/
public Builder setDurationField(com.google.protobuf.Duration value) {
if (durationFieldBuilder_ == null) {
if (value == null) {
throw new NullPointerException();
}
durationField_ = value;
onChanged();
} else {
durationFieldBuilder_.setMessage(value);
}
return this;
}
/**
* <pre>
* TODO value types
* </pre>
*
* <code>.google.protobuf.Duration duration_field = 2;</code>
*/
public Builder setDurationField(
com.google.protobuf.Duration.Builder builderForValue) {
if (durationFieldBuilder_ == null) {
durationField_ = builderForValue.build();
onChanged();
} else {
durationFieldBuilder_.setMessage(builderForValue.build());
}
return this;
}
/**
* <pre>
* TODO value types
* </pre>
*
* <code>.google.protobuf.Duration duration_field = 2;</code>
*/
public Builder mergeDurationField(com.google.protobuf.Duration value) {
if (durationFieldBuilder_ == null) {
if (durationField_ != null) {
durationField_ =
com.google.protobuf.Duration.newBuilder(durationField_).mergeFrom(value).buildPartial();
} else {
durationField_ = value;
}
onChanged();
} else {
durationFieldBuilder_.mergeFrom(value);
}
return this;
}
/**
* <pre>
* TODO value types
* </pre>
*
* <code>.google.protobuf.Duration duration_field = 2;</code>
*/
public Builder clearDurationField() {
if (durationFieldBuilder_ == null) {
durationField_ = null;
onChanged();
} else {
durationField_ = null;
durationFieldBuilder_ = null;
}
return this;
}
/**
* <pre>
* TODO value types
* </pre>
*
* <code>.google.protobuf.Duration duration_field = 2;</code>
*/
public com.google.protobuf.Duration.Builder getDurationFieldBuilder() {
onChanged();
return getDurationFieldFieldBuilder().getBuilder();
}
/**
* <pre>
* TODO value types
* </pre>
*
* <code>.google.protobuf.Duration duration_field = 2;</code>
*/
public com.google.protobuf.DurationOrBuilder getDurationFieldOrBuilder() {
if (durationFieldBuilder_ != null) {
return durationFieldBuilder_.getMessageOrBuilder();
} else {
return durationField_ == null ?
com.google.protobuf.Duration.getDefaultInstance() : durationField_;
}
}
/**
* <pre>
* TODO value types
* </pre>
*
* <code>.google.protobuf.Duration duration_field = 2;</code>
*/
private com.google.protobuf.SingleFieldBuilderV3<
com.google.protobuf.Duration, com.google.protobuf.Duration.Builder, com.google.protobuf.DurationOrBuilder>
getDurationFieldFieldBuilder() {
if (durationFieldBuilder_ == null) {
durationFieldBuilder_ = new com.google.protobuf.SingleFieldBuilderV3<
com.google.protobuf.Duration, com.google.protobuf.Duration.Builder, com.google.protobuf.DurationOrBuilder>(
getDurationField(),
getParentForChildren(),
isClean());
durationField_ = null;
}
return durationFieldBuilder_;
}
@java.lang.Override
public final Builder setUnknownFields(
final com.google.protobuf.UnknownFieldSet unknownFields) {
return super.setUnknownFields(unknownFields);
}
@java.lang.Override
public final Builder mergeUnknownFields(
final com.google.protobuf.UnknownFieldSet unknownFields) {
return super.mergeUnknownFields(unknownFields);
}
// @@protoc_insertion_point(builder_scope:io.bkbn.kompendium.protobufjavaconverter.GoogleTypes)
}
// @@protoc_insertion_point(class_scope:io.bkbn.kompendium.protobufjavaconverter.GoogleTypes)
private static final io.bkbn.kompendium.protobufjavaconverter.GoogleTypes DEFAULT_INSTANCE;
static {
DEFAULT_INSTANCE = new io.bkbn.kompendium.protobufjavaconverter.GoogleTypes();
}
public static io.bkbn.kompendium.protobufjavaconverter.GoogleTypes getDefaultInstance() {
return DEFAULT_INSTANCE;
}
private static final com.google.protobuf.Parser<GoogleTypes>
PARSER = new com.google.protobuf.AbstractParser<GoogleTypes>() {
@java.lang.Override
public GoogleTypes parsePartialFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return new GoogleTypes(input, extensionRegistry);
}
};
public static com.google.protobuf.Parser<GoogleTypes> parser() {
return PARSER;
}
@java.lang.Override
public com.google.protobuf.Parser<GoogleTypes> getParserForType() {
return PARSER;
}
@java.lang.Override
public io.bkbn.kompendium.protobufjavaconverter.GoogleTypes getDefaultInstanceForType() {
return DEFAULT_INSTANCE;
}
}

View File

@ -0,0 +1,51 @@
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: io/bkbn/kompendium/protobufjavaconverter/converters/test.proto
package io.bkbn.kompendium.protobufjavaconverter;
public interface GoogleTypesOrBuilder extends
// @@protoc_insertion_point(interface_extends:io.bkbn.kompendium.protobufjavaconverter.GoogleTypes)
com.google.protobuf.MessageOrBuilder {
/**
* <code>.google.protobuf.Timestamp timestamp_field = 1;</code>
* @return Whether the timestampField field is set.
*/
boolean hasTimestampField();
/**
* <code>.google.protobuf.Timestamp timestamp_field = 1;</code>
* @return The timestampField.
*/
com.google.protobuf.Timestamp getTimestampField();
/**
* <code>.google.protobuf.Timestamp timestamp_field = 1;</code>
*/
com.google.protobuf.TimestampOrBuilder getTimestampFieldOrBuilder();
/**
* <pre>
* TODO value types
* </pre>
*
* <code>.google.protobuf.Duration duration_field = 2;</code>
* @return Whether the durationField field is set.
*/
boolean hasDurationField();
/**
* <pre>
* TODO value types
* </pre>
*
* <code>.google.protobuf.Duration duration_field = 2;</code>
* @return The durationField.
*/
com.google.protobuf.Duration getDurationField();
/**
* <pre>
* TODO value types
* </pre>
*
* <code>.google.protobuf.Duration duration_field = 2;</code>
*/
com.google.protobuf.DurationOrBuilder getDurationFieldOrBuilder();
}

View File

@ -0,0 +1,705 @@
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: io/bkbn/kompendium/protobufjavaconverter/converters/test.proto
package io.bkbn.kompendium.protobufjavaconverter;
/**
* Protobuf type {@code io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage}
*/
public final class NestedMapMessage extends
com.google.protobuf.GeneratedMessageV3 implements
// @@protoc_insertion_point(message_implements:io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage)
NestedMapMessageOrBuilder {
private static final long serialVersionUID = 0L;
// Use NestedMapMessage.newBuilder() to construct.
private NestedMapMessage(com.google.protobuf.GeneratedMessageV3.Builder<?> builder) {
super(builder);
}
private NestedMapMessage() {
}
@java.lang.Override
@SuppressWarnings({"unused"})
protected java.lang.Object newInstance(
UnusedPrivateParameter unused) {
return new NestedMapMessage();
}
@java.lang.Override
public final com.google.protobuf.UnknownFieldSet
getUnknownFields() {
return this.unknownFields;
}
private NestedMapMessage(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
this();
if (extensionRegistry == null) {
throw new java.lang.NullPointerException();
}
int mutable_bitField0_ = 0;
com.google.protobuf.UnknownFieldSet.Builder unknownFields =
com.google.protobuf.UnknownFieldSet.newBuilder();
try {
boolean done = false;
while (!done) {
int tag = input.readTag();
switch (tag) {
case 0:
done = true;
break;
case 10: {
if (!((mutable_bitField0_ & 0x00000001) != 0)) {
mapField_ = com.google.protobuf.MapField.newMapField(
MapFieldDefaultEntryHolder.defaultEntry);
mutable_bitField0_ |= 0x00000001;
}
com.google.protobuf.MapEntry<java.lang.String, io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage>
mapField__ = input.readMessage(
MapFieldDefaultEntryHolder.defaultEntry.getParserForType(), extensionRegistry);
mapField_.getMutableMap().put(
mapField__.getKey(), mapField__.getValue());
break;
}
default: {
if (!parseUnknownField(
input, unknownFields, extensionRegistry, tag)) {
done = true;
}
break;
}
}
}
} catch (com.google.protobuf.InvalidProtocolBufferException e) {
throw e.setUnfinishedMessage(this);
} catch (java.io.IOException e) {
throw new com.google.protobuf.InvalidProtocolBufferException(
e).setUnfinishedMessage(this);
} finally {
this.unknownFields = unknownFields.build();
makeExtensionsImmutable();
}
}
public static final com.google.protobuf.Descriptors.Descriptor
getDescriptor() {
return io.bkbn.kompendium.protobufjavaconverter.Test.internal_static_io_bkbn_kompendium_protobufjavaconverter_NestedMapMessage_descriptor;
}
@SuppressWarnings({"rawtypes"})
@java.lang.Override
protected com.google.protobuf.MapField internalGetMapField(
int number) {
switch (number) {
case 1:
return internalGetMapField();
default:
throw new RuntimeException(
"Invalid map field number: " + number);
}
}
@java.lang.Override
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable() {
return io.bkbn.kompendium.protobufjavaconverter.Test.internal_static_io_bkbn_kompendium_protobufjavaconverter_NestedMapMessage_fieldAccessorTable
.ensureFieldAccessorsInitialized(
io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage.class, io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage.Builder.class);
}
public static final int MAP_FIELD_FIELD_NUMBER = 1;
private static final class MapFieldDefaultEntryHolder {
static final com.google.protobuf.MapEntry<
java.lang.String, io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage> defaultEntry =
com.google.protobuf.MapEntry
.<java.lang.String, io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage>newDefaultInstance(
io.bkbn.kompendium.protobufjavaconverter.Test.internal_static_io_bkbn_kompendium_protobufjavaconverter_NestedMapMessage_MapFieldEntry_descriptor,
com.google.protobuf.WireFormat.FieldType.STRING,
"",
com.google.protobuf.WireFormat.FieldType.MESSAGE,
io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage.getDefaultInstance());
}
private com.google.protobuf.MapField<
java.lang.String, io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage> mapField_;
private com.google.protobuf.MapField<java.lang.String, io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage>
internalGetMapField() {
if (mapField_ == null) {
return com.google.protobuf.MapField.emptyMapField(
MapFieldDefaultEntryHolder.defaultEntry);
}
return mapField_;
}
public int getMapFieldCount() {
return internalGetMapField().getMap().size();
}
/**
* <code>map&lt;string, .io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage&gt; map_field = 1;</code>
*/
@java.lang.Override
public boolean containsMapField(
java.lang.String key) {
if (key == null) { throw new java.lang.NullPointerException(); }
return internalGetMapField().getMap().containsKey(key);
}
/**
* Use {@link #getMapFieldMap()} instead.
*/
@java.lang.Override
@java.lang.Deprecated
public java.util.Map<java.lang.String, io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage> getMapField() {
return getMapFieldMap();
}
/**
* <code>map&lt;string, .io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage&gt; map_field = 1;</code>
*/
@java.lang.Override
public java.util.Map<java.lang.String, io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage> getMapFieldMap() {
return internalGetMapField().getMap();
}
/**
* <code>map&lt;string, .io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage&gt; map_field = 1;</code>
*/
@java.lang.Override
public io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage getMapFieldOrDefault(
java.lang.String key,
io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage defaultValue) {
if (key == null) { throw new java.lang.NullPointerException(); }
java.util.Map<java.lang.String, io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage> map =
internalGetMapField().getMap();
return map.containsKey(key) ? map.get(key) : defaultValue;
}
/**
* <code>map&lt;string, .io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage&gt; map_field = 1;</code>
*/
@java.lang.Override
public io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage getMapFieldOrThrow(
java.lang.String key) {
if (key == null) { throw new java.lang.NullPointerException(); }
java.util.Map<java.lang.String, io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage> map =
internalGetMapField().getMap();
if (!map.containsKey(key)) {
throw new java.lang.IllegalArgumentException();
}
return map.get(key);
}
private byte memoizedIsInitialized = -1;
@java.lang.Override
public final boolean isInitialized() {
byte isInitialized = memoizedIsInitialized;
if (isInitialized == 1) return true;
if (isInitialized == 0) return false;
memoizedIsInitialized = 1;
return true;
}
@java.lang.Override
public void writeTo(com.google.protobuf.CodedOutputStream output)
throws java.io.IOException {
com.google.protobuf.GeneratedMessageV3
.serializeStringMapTo(
output,
internalGetMapField(),
MapFieldDefaultEntryHolder.defaultEntry,
1);
unknownFields.writeTo(output);
}
@java.lang.Override
public int getSerializedSize() {
int size = memoizedSize;
if (size != -1) return size;
size = 0;
for (java.util.Map.Entry<java.lang.String, io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage> entry
: internalGetMapField().getMap().entrySet()) {
com.google.protobuf.MapEntry<java.lang.String, io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage>
mapField__ = MapFieldDefaultEntryHolder.defaultEntry.newBuilderForType()
.setKey(entry.getKey())
.setValue(entry.getValue())
.build();
size += com.google.protobuf.CodedOutputStream
.computeMessageSize(1, mapField__);
}
size += unknownFields.getSerializedSize();
memoizedSize = size;
return size;
}
@java.lang.Override
public boolean equals(final java.lang.Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage)) {
return super.equals(obj);
}
io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage other = (io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage) obj;
if (!internalGetMapField().equals(
other.internalGetMapField())) return false;
if (!unknownFields.equals(other.unknownFields)) return false;
return true;
}
@java.lang.Override
public int hashCode() {
if (memoizedHashCode != 0) {
return memoizedHashCode;
}
int hash = 41;
hash = (19 * hash) + getDescriptor().hashCode();
if (!internalGetMapField().getMap().isEmpty()) {
hash = (37 * hash) + MAP_FIELD_FIELD_NUMBER;
hash = (53 * hash) + internalGetMapField().hashCode();
}
hash = (29 * hash) + unknownFields.hashCode();
memoizedHashCode = hash;
return hash;
}
public static io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage parseFrom(
java.nio.ByteBuffer data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage parseFrom(
java.nio.ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage parseFrom(
com.google.protobuf.ByteString data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage parseFrom(
com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage parseFrom(byte[] data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage parseFrom(
byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage parseFrom(java.io.InputStream input)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input);
}
public static io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage parseFrom(
java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input, extensionRegistry);
}
public static io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage parseDelimitedFrom(java.io.InputStream input)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseDelimitedWithIOException(PARSER, input);
}
public static io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage parseDelimitedFrom(
java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseDelimitedWithIOException(PARSER, input, extensionRegistry);
}
public static io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage parseFrom(
com.google.protobuf.CodedInputStream input)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input);
}
public static io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage parseFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input, extensionRegistry);
}
@java.lang.Override
public Builder newBuilderForType() { return newBuilder(); }
public static Builder newBuilder() {
return DEFAULT_INSTANCE.toBuilder();
}
public static Builder newBuilder(io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage prototype) {
return DEFAULT_INSTANCE.toBuilder().mergeFrom(prototype);
}
@java.lang.Override
public Builder toBuilder() {
return this == DEFAULT_INSTANCE
? new Builder() : new Builder().mergeFrom(this);
}
@java.lang.Override
protected Builder newBuilderForType(
com.google.protobuf.GeneratedMessageV3.BuilderParent parent) {
Builder builder = new Builder(parent);
return builder;
}
/**
* Protobuf type {@code io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage}
*/
public static final class Builder extends
com.google.protobuf.GeneratedMessageV3.Builder<Builder> implements
// @@protoc_insertion_point(builder_implements:io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage)
io.bkbn.kompendium.protobufjavaconverter.NestedMapMessageOrBuilder {
public static final com.google.protobuf.Descriptors.Descriptor
getDescriptor() {
return io.bkbn.kompendium.protobufjavaconverter.Test.internal_static_io_bkbn_kompendium_protobufjavaconverter_NestedMapMessage_descriptor;
}
@SuppressWarnings({"rawtypes"})
protected com.google.protobuf.MapField internalGetMapField(
int number) {
switch (number) {
case 1:
return internalGetMapField();
default:
throw new RuntimeException(
"Invalid map field number: " + number);
}
}
@SuppressWarnings({"rawtypes"})
protected com.google.protobuf.MapField internalGetMutableMapField(
int number) {
switch (number) {
case 1:
return internalGetMutableMapField();
default:
throw new RuntimeException(
"Invalid map field number: " + number);
}
}
@java.lang.Override
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable() {
return io.bkbn.kompendium.protobufjavaconverter.Test.internal_static_io_bkbn_kompendium_protobufjavaconverter_NestedMapMessage_fieldAccessorTable
.ensureFieldAccessorsInitialized(
io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage.class, io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage.Builder.class);
}
// Construct using io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage.newBuilder()
private Builder() {
maybeForceBuilderInitialization();
}
private Builder(
com.google.protobuf.GeneratedMessageV3.BuilderParent parent) {
super(parent);
maybeForceBuilderInitialization();
}
private void maybeForceBuilderInitialization() {
if (com.google.protobuf.GeneratedMessageV3
.alwaysUseFieldBuilders) {
}
}
@java.lang.Override
public Builder clear() {
super.clear();
internalGetMutableMapField().clear();
return this;
}
@java.lang.Override
public com.google.protobuf.Descriptors.Descriptor
getDescriptorForType() {
return io.bkbn.kompendium.protobufjavaconverter.Test.internal_static_io_bkbn_kompendium_protobufjavaconverter_NestedMapMessage_descriptor;
}
@java.lang.Override
public io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage getDefaultInstanceForType() {
return io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage.getDefaultInstance();
}
@java.lang.Override
public io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage build() {
io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage result = buildPartial();
if (!result.isInitialized()) {
throw newUninitializedMessageException(result);
}
return result;
}
@java.lang.Override
public io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage buildPartial() {
io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage result = new io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage(this);
int from_bitField0_ = bitField0_;
result.mapField_ = internalGetMapField();
result.mapField_.makeImmutable();
onBuilt();
return result;
}
@java.lang.Override
public Builder clone() {
return super.clone();
}
@java.lang.Override
public Builder setField(
com.google.protobuf.Descriptors.FieldDescriptor field,
java.lang.Object value) {
return super.setField(field, value);
}
@java.lang.Override
public Builder clearField(
com.google.protobuf.Descriptors.FieldDescriptor field) {
return super.clearField(field);
}
@java.lang.Override
public Builder clearOneof(
com.google.protobuf.Descriptors.OneofDescriptor oneof) {
return super.clearOneof(oneof);
}
@java.lang.Override
public Builder setRepeatedField(
com.google.protobuf.Descriptors.FieldDescriptor field,
int index, java.lang.Object value) {
return super.setRepeatedField(field, index, value);
}
@java.lang.Override
public Builder addRepeatedField(
com.google.protobuf.Descriptors.FieldDescriptor field,
java.lang.Object value) {
return super.addRepeatedField(field, value);
}
@java.lang.Override
public Builder mergeFrom(com.google.protobuf.Message other) {
if (other instanceof io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage) {
return mergeFrom((io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage)other);
} else {
super.mergeFrom(other);
return this;
}
}
public Builder mergeFrom(io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage other) {
if (other == io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage.getDefaultInstance()) return this;
internalGetMutableMapField().mergeFrom(
other.internalGetMapField());
this.mergeUnknownFields(other.unknownFields);
onChanged();
return this;
}
@java.lang.Override
public final boolean isInitialized() {
return true;
}
@java.lang.Override
public Builder mergeFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage parsedMessage = null;
try {
parsedMessage = PARSER.parsePartialFrom(input, extensionRegistry);
} catch (com.google.protobuf.InvalidProtocolBufferException e) {
parsedMessage = (io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage) e.getUnfinishedMessage();
throw e.unwrapIOException();
} finally {
if (parsedMessage != null) {
mergeFrom(parsedMessage);
}
}
return this;
}
private int bitField0_;
private com.google.protobuf.MapField<
java.lang.String, io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage> mapField_;
private com.google.protobuf.MapField<java.lang.String, io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage>
internalGetMapField() {
if (mapField_ == null) {
return com.google.protobuf.MapField.emptyMapField(
MapFieldDefaultEntryHolder.defaultEntry);
}
return mapField_;
}
private com.google.protobuf.MapField<java.lang.String, io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage>
internalGetMutableMapField() {
onChanged();;
if (mapField_ == null) {
mapField_ = com.google.protobuf.MapField.newMapField(
MapFieldDefaultEntryHolder.defaultEntry);
}
if (!mapField_.isMutable()) {
mapField_ = mapField_.copy();
}
return mapField_;
}
public int getMapFieldCount() {
return internalGetMapField().getMap().size();
}
/**
* <code>map&lt;string, .io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage&gt; map_field = 1;</code>
*/
@java.lang.Override
public boolean containsMapField(
java.lang.String key) {
if (key == null) { throw new java.lang.NullPointerException(); }
return internalGetMapField().getMap().containsKey(key);
}
/**
* Use {@link #getMapFieldMap()} instead.
*/
@java.lang.Override
@java.lang.Deprecated
public java.util.Map<java.lang.String, io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage> getMapField() {
return getMapFieldMap();
}
/**
* <code>map&lt;string, .io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage&gt; map_field = 1;</code>
*/
@java.lang.Override
public java.util.Map<java.lang.String, io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage> getMapFieldMap() {
return internalGetMapField().getMap();
}
/**
* <code>map&lt;string, .io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage&gt; map_field = 1;</code>
*/
@java.lang.Override
public io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage getMapFieldOrDefault(
java.lang.String key,
io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage defaultValue) {
if (key == null) { throw new java.lang.NullPointerException(); }
java.util.Map<java.lang.String, io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage> map =
internalGetMapField().getMap();
return map.containsKey(key) ? map.get(key) : defaultValue;
}
/**
* <code>map&lt;string, .io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage&gt; map_field = 1;</code>
*/
@java.lang.Override
public io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage getMapFieldOrThrow(
java.lang.String key) {
if (key == null) { throw new java.lang.NullPointerException(); }
java.util.Map<java.lang.String, io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage> map =
internalGetMapField().getMap();
if (!map.containsKey(key)) {
throw new java.lang.IllegalArgumentException();
}
return map.get(key);
}
public Builder clearMapField() {
internalGetMutableMapField().getMutableMap()
.clear();
return this;
}
/**
* <code>map&lt;string, .io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage&gt; map_field = 1;</code>
*/
public Builder removeMapField(
java.lang.String key) {
if (key == null) { throw new java.lang.NullPointerException(); }
internalGetMutableMapField().getMutableMap()
.remove(key);
return this;
}
/**
* Use alternate mutation accessors instead.
*/
@java.lang.Deprecated
public java.util.Map<java.lang.String, io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage>
getMutableMapField() {
return internalGetMutableMapField().getMutableMap();
}
/**
* <code>map&lt;string, .io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage&gt; map_field = 1;</code>
*/
public Builder putMapField(
java.lang.String key,
io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage value) {
if (key == null) { throw new java.lang.NullPointerException(); }
if (value == null) { throw new java.lang.NullPointerException(); }
internalGetMutableMapField().getMutableMap()
.put(key, value);
return this;
}
/**
* <code>map&lt;string, .io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage&gt; map_field = 1;</code>
*/
public Builder putAllMapField(
java.util.Map<java.lang.String, io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage> values) {
internalGetMutableMapField().getMutableMap()
.putAll(values);
return this;
}
@java.lang.Override
public final Builder setUnknownFields(
final com.google.protobuf.UnknownFieldSet unknownFields) {
return super.setUnknownFields(unknownFields);
}
@java.lang.Override
public final Builder mergeUnknownFields(
final com.google.protobuf.UnknownFieldSet unknownFields) {
return super.mergeUnknownFields(unknownFields);
}
// @@protoc_insertion_point(builder_scope:io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage)
}
// @@protoc_insertion_point(class_scope:io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage)
private static final io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage DEFAULT_INSTANCE;
static {
DEFAULT_INSTANCE = new io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage();
}
public static io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage getDefaultInstance() {
return DEFAULT_INSTANCE;
}
private static final com.google.protobuf.Parser<NestedMapMessage>
PARSER = new com.google.protobuf.AbstractParser<NestedMapMessage>() {
@java.lang.Override
public NestedMapMessage parsePartialFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return new NestedMapMessage(input, extensionRegistry);
}
};
public static com.google.protobuf.Parser<NestedMapMessage> parser() {
return PARSER;
}
@java.lang.Override
public com.google.protobuf.Parser<NestedMapMessage> getParserForType() {
return PARSER;
}
@java.lang.Override
public io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage getDefaultInstanceForType() {
return DEFAULT_INSTANCE;
}
}

View File

@ -0,0 +1,43 @@
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: io/bkbn/kompendium/protobufjavaconverter/converters/test.proto
package io.bkbn.kompendium.protobufjavaconverter;
public interface NestedMapMessageOrBuilder extends
// @@protoc_insertion_point(interface_extends:io.bkbn.kompendium.protobufjavaconverter.NestedMapMessage)
com.google.protobuf.MessageOrBuilder {
/**
* <code>map&lt;string, .io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage&gt; map_field = 1;</code>
*/
int getMapFieldCount();
/**
* <code>map&lt;string, .io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage&gt; map_field = 1;</code>
*/
boolean containsMapField(
java.lang.String key);
/**
* Use {@link #getMapFieldMap()} instead.
*/
@java.lang.Deprecated
java.util.Map<java.lang.String, io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage>
getMapField();
/**
* <code>map&lt;string, .io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage&gt; map_field = 1;</code>
*/
java.util.Map<java.lang.String, io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage>
getMapFieldMap();
/**
* <code>map&lt;string, .io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage&gt; map_field = 1;</code>
*/
io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage getMapFieldOrDefault(
java.lang.String key,
io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage defaultValue);
/**
* <code>map&lt;string, .io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage&gt; map_field = 1;</code>
*/
io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage getMapFieldOrThrow(
java.lang.String key);
}

View File

@ -0,0 +1,607 @@
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: io/bkbn/kompendium/protobufjavaconverter/converters/test.proto
package io.bkbn.kompendium.protobufjavaconverter;
/**
* Protobuf type {@code io.bkbn.kompendium.protobufjavaconverter.NestedMessage}
*/
public final class NestedMessage extends
com.google.protobuf.GeneratedMessageV3 implements
// @@protoc_insertion_point(message_implements:io.bkbn.kompendium.protobufjavaconverter.NestedMessage)
NestedMessageOrBuilder {
private static final long serialVersionUID = 0L;
// Use NestedMessage.newBuilder() to construct.
private NestedMessage(com.google.protobuf.GeneratedMessageV3.Builder<?> builder) {
super(builder);
}
private NestedMessage() {
}
@java.lang.Override
@SuppressWarnings({"unused"})
protected java.lang.Object newInstance(
UnusedPrivateParameter unused) {
return new NestedMessage();
}
@java.lang.Override
public final com.google.protobuf.UnknownFieldSet
getUnknownFields() {
return this.unknownFields;
}
private NestedMessage(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
this();
if (extensionRegistry == null) {
throw new java.lang.NullPointerException();
}
com.google.protobuf.UnknownFieldSet.Builder unknownFields =
com.google.protobuf.UnknownFieldSet.newBuilder();
try {
boolean done = false;
while (!done) {
int tag = input.readTag();
switch (tag) {
case 0:
done = true;
break;
case 10: {
io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage.Builder subBuilder = null;
if (nestedField_ != null) {
subBuilder = nestedField_.toBuilder();
}
nestedField_ = input.readMessage(io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage.parser(), extensionRegistry);
if (subBuilder != null) {
subBuilder.mergeFrom(nestedField_);
nestedField_ = subBuilder.buildPartial();
}
break;
}
default: {
if (!parseUnknownField(
input, unknownFields, extensionRegistry, tag)) {
done = true;
}
break;
}
}
}
} catch (com.google.protobuf.InvalidProtocolBufferException e) {
throw e.setUnfinishedMessage(this);
} catch (java.io.IOException e) {
throw new com.google.protobuf.InvalidProtocolBufferException(
e).setUnfinishedMessage(this);
} finally {
this.unknownFields = unknownFields.build();
makeExtensionsImmutable();
}
}
public static final com.google.protobuf.Descriptors.Descriptor
getDescriptor() {
return io.bkbn.kompendium.protobufjavaconverter.Test.internal_static_io_bkbn_kompendium_protobufjavaconverter_NestedMessage_descriptor;
}
@java.lang.Override
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable() {
return io.bkbn.kompendium.protobufjavaconverter.Test.internal_static_io_bkbn_kompendium_protobufjavaconverter_NestedMessage_fieldAccessorTable
.ensureFieldAccessorsInitialized(
io.bkbn.kompendium.protobufjavaconverter.NestedMessage.class, io.bkbn.kompendium.protobufjavaconverter.NestedMessage.Builder.class);
}
public static final int NESTED_FIELD_FIELD_NUMBER = 1;
private io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage nestedField_;
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage nested_field = 1;</code>
* @return Whether the nestedField field is set.
*/
@java.lang.Override
public boolean hasNestedField() {
return nestedField_ != null;
}
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage nested_field = 1;</code>
* @return The nestedField.
*/
@java.lang.Override
public io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage getNestedField() {
return nestedField_ == null ? io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage.getDefaultInstance() : nestedField_;
}
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage nested_field = 1;</code>
*/
@java.lang.Override
public io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessageOrBuilder getNestedFieldOrBuilder() {
return getNestedField();
}
private byte memoizedIsInitialized = -1;
@java.lang.Override
public final boolean isInitialized() {
byte isInitialized = memoizedIsInitialized;
if (isInitialized == 1) return true;
if (isInitialized == 0) return false;
memoizedIsInitialized = 1;
return true;
}
@java.lang.Override
public void writeTo(com.google.protobuf.CodedOutputStream output)
throws java.io.IOException {
if (nestedField_ != null) {
output.writeMessage(1, getNestedField());
}
unknownFields.writeTo(output);
}
@java.lang.Override
public int getSerializedSize() {
int size = memoizedSize;
if (size != -1) return size;
size = 0;
if (nestedField_ != null) {
size += com.google.protobuf.CodedOutputStream
.computeMessageSize(1, getNestedField());
}
size += unknownFields.getSerializedSize();
memoizedSize = size;
return size;
}
@java.lang.Override
public boolean equals(final java.lang.Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof io.bkbn.kompendium.protobufjavaconverter.NestedMessage)) {
return super.equals(obj);
}
io.bkbn.kompendium.protobufjavaconverter.NestedMessage other = (io.bkbn.kompendium.protobufjavaconverter.NestedMessage) obj;
if (hasNestedField() != other.hasNestedField()) return false;
if (hasNestedField()) {
if (!getNestedField()
.equals(other.getNestedField())) return false;
}
if (!unknownFields.equals(other.unknownFields)) return false;
return true;
}
@java.lang.Override
public int hashCode() {
if (memoizedHashCode != 0) {
return memoizedHashCode;
}
int hash = 41;
hash = (19 * hash) + getDescriptor().hashCode();
if (hasNestedField()) {
hash = (37 * hash) + NESTED_FIELD_FIELD_NUMBER;
hash = (53 * hash) + getNestedField().hashCode();
}
hash = (29 * hash) + unknownFields.hashCode();
memoizedHashCode = hash;
return hash;
}
public static io.bkbn.kompendium.protobufjavaconverter.NestedMessage parseFrom(
java.nio.ByteBuffer data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static io.bkbn.kompendium.protobufjavaconverter.NestedMessage parseFrom(
java.nio.ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static io.bkbn.kompendium.protobufjavaconverter.NestedMessage parseFrom(
com.google.protobuf.ByteString data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static io.bkbn.kompendium.protobufjavaconverter.NestedMessage parseFrom(
com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static io.bkbn.kompendium.protobufjavaconverter.NestedMessage parseFrom(byte[] data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static io.bkbn.kompendium.protobufjavaconverter.NestedMessage parseFrom(
byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static io.bkbn.kompendium.protobufjavaconverter.NestedMessage parseFrom(java.io.InputStream input)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input);
}
public static io.bkbn.kompendium.protobufjavaconverter.NestedMessage parseFrom(
java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input, extensionRegistry);
}
public static io.bkbn.kompendium.protobufjavaconverter.NestedMessage parseDelimitedFrom(java.io.InputStream input)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseDelimitedWithIOException(PARSER, input);
}
public static io.bkbn.kompendium.protobufjavaconverter.NestedMessage parseDelimitedFrom(
java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseDelimitedWithIOException(PARSER, input, extensionRegistry);
}
public static io.bkbn.kompendium.protobufjavaconverter.NestedMessage parseFrom(
com.google.protobuf.CodedInputStream input)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input);
}
public static io.bkbn.kompendium.protobufjavaconverter.NestedMessage parseFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input, extensionRegistry);
}
@java.lang.Override
public Builder newBuilderForType() { return newBuilder(); }
public static Builder newBuilder() {
return DEFAULT_INSTANCE.toBuilder();
}
public static Builder newBuilder(io.bkbn.kompendium.protobufjavaconverter.NestedMessage prototype) {
return DEFAULT_INSTANCE.toBuilder().mergeFrom(prototype);
}
@java.lang.Override
public Builder toBuilder() {
return this == DEFAULT_INSTANCE
? new Builder() : new Builder().mergeFrom(this);
}
@java.lang.Override
protected Builder newBuilderForType(
com.google.protobuf.GeneratedMessageV3.BuilderParent parent) {
Builder builder = new Builder(parent);
return builder;
}
/**
* Protobuf type {@code io.bkbn.kompendium.protobufjavaconverter.NestedMessage}
*/
public static final class Builder extends
com.google.protobuf.GeneratedMessageV3.Builder<Builder> implements
// @@protoc_insertion_point(builder_implements:io.bkbn.kompendium.protobufjavaconverter.NestedMessage)
io.bkbn.kompendium.protobufjavaconverter.NestedMessageOrBuilder {
public static final com.google.protobuf.Descriptors.Descriptor
getDescriptor() {
return io.bkbn.kompendium.protobufjavaconverter.Test.internal_static_io_bkbn_kompendium_protobufjavaconverter_NestedMessage_descriptor;
}
@java.lang.Override
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable() {
return io.bkbn.kompendium.protobufjavaconverter.Test.internal_static_io_bkbn_kompendium_protobufjavaconverter_NestedMessage_fieldAccessorTable
.ensureFieldAccessorsInitialized(
io.bkbn.kompendium.protobufjavaconverter.NestedMessage.class, io.bkbn.kompendium.protobufjavaconverter.NestedMessage.Builder.class);
}
// Construct using io.bkbn.kompendium.protobufjavaconverter.NestedMessage.newBuilder()
private Builder() {
maybeForceBuilderInitialization();
}
private Builder(
com.google.protobuf.GeneratedMessageV3.BuilderParent parent) {
super(parent);
maybeForceBuilderInitialization();
}
private void maybeForceBuilderInitialization() {
if (com.google.protobuf.GeneratedMessageV3
.alwaysUseFieldBuilders) {
}
}
@java.lang.Override
public Builder clear() {
super.clear();
if (nestedFieldBuilder_ == null) {
nestedField_ = null;
} else {
nestedField_ = null;
nestedFieldBuilder_ = null;
}
return this;
}
@java.lang.Override
public com.google.protobuf.Descriptors.Descriptor
getDescriptorForType() {
return io.bkbn.kompendium.protobufjavaconverter.Test.internal_static_io_bkbn_kompendium_protobufjavaconverter_NestedMessage_descriptor;
}
@java.lang.Override
public io.bkbn.kompendium.protobufjavaconverter.NestedMessage getDefaultInstanceForType() {
return io.bkbn.kompendium.protobufjavaconverter.NestedMessage.getDefaultInstance();
}
@java.lang.Override
public io.bkbn.kompendium.protobufjavaconverter.NestedMessage build() {
io.bkbn.kompendium.protobufjavaconverter.NestedMessage result = buildPartial();
if (!result.isInitialized()) {
throw newUninitializedMessageException(result);
}
return result;
}
@java.lang.Override
public io.bkbn.kompendium.protobufjavaconverter.NestedMessage buildPartial() {
io.bkbn.kompendium.protobufjavaconverter.NestedMessage result = new io.bkbn.kompendium.protobufjavaconverter.NestedMessage(this);
if (nestedFieldBuilder_ == null) {
result.nestedField_ = nestedField_;
} else {
result.nestedField_ = nestedFieldBuilder_.build();
}
onBuilt();
return result;
}
@java.lang.Override
public Builder clone() {
return super.clone();
}
@java.lang.Override
public Builder setField(
com.google.protobuf.Descriptors.FieldDescriptor field,
java.lang.Object value) {
return super.setField(field, value);
}
@java.lang.Override
public Builder clearField(
com.google.protobuf.Descriptors.FieldDescriptor field) {
return super.clearField(field);
}
@java.lang.Override
public Builder clearOneof(
com.google.protobuf.Descriptors.OneofDescriptor oneof) {
return super.clearOneof(oneof);
}
@java.lang.Override
public Builder setRepeatedField(
com.google.protobuf.Descriptors.FieldDescriptor field,
int index, java.lang.Object value) {
return super.setRepeatedField(field, index, value);
}
@java.lang.Override
public Builder addRepeatedField(
com.google.protobuf.Descriptors.FieldDescriptor field,
java.lang.Object value) {
return super.addRepeatedField(field, value);
}
@java.lang.Override
public Builder mergeFrom(com.google.protobuf.Message other) {
if (other instanceof io.bkbn.kompendium.protobufjavaconverter.NestedMessage) {
return mergeFrom((io.bkbn.kompendium.protobufjavaconverter.NestedMessage)other);
} else {
super.mergeFrom(other);
return this;
}
}
public Builder mergeFrom(io.bkbn.kompendium.protobufjavaconverter.NestedMessage other) {
if (other == io.bkbn.kompendium.protobufjavaconverter.NestedMessage.getDefaultInstance()) return this;
if (other.hasNestedField()) {
mergeNestedField(other.getNestedField());
}
this.mergeUnknownFields(other.unknownFields);
onChanged();
return this;
}
@java.lang.Override
public final boolean isInitialized() {
return true;
}
@java.lang.Override
public Builder mergeFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
io.bkbn.kompendium.protobufjavaconverter.NestedMessage parsedMessage = null;
try {
parsedMessage = PARSER.parsePartialFrom(input, extensionRegistry);
} catch (com.google.protobuf.InvalidProtocolBufferException e) {
parsedMessage = (io.bkbn.kompendium.protobufjavaconverter.NestedMessage) e.getUnfinishedMessage();
throw e.unwrapIOException();
} finally {
if (parsedMessage != null) {
mergeFrom(parsedMessage);
}
}
return this;
}
private io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage nestedField_;
private com.google.protobuf.SingleFieldBuilderV3<
io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage, io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage.Builder, io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessageOrBuilder> nestedFieldBuilder_;
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage nested_field = 1;</code>
* @return Whether the nestedField field is set.
*/
public boolean hasNestedField() {
return nestedFieldBuilder_ != null || nestedField_ != null;
}
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage nested_field = 1;</code>
* @return The nestedField.
*/
public io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage getNestedField() {
if (nestedFieldBuilder_ == null) {
return nestedField_ == null ? io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage.getDefaultInstance() : nestedField_;
} else {
return nestedFieldBuilder_.getMessage();
}
}
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage nested_field = 1;</code>
*/
public Builder setNestedField(io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage value) {
if (nestedFieldBuilder_ == null) {
if (value == null) {
throw new NullPointerException();
}
nestedField_ = value;
onChanged();
} else {
nestedFieldBuilder_.setMessage(value);
}
return this;
}
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage nested_field = 1;</code>
*/
public Builder setNestedField(
io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage.Builder builderForValue) {
if (nestedFieldBuilder_ == null) {
nestedField_ = builderForValue.build();
onChanged();
} else {
nestedFieldBuilder_.setMessage(builderForValue.build());
}
return this;
}
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage nested_field = 1;</code>
*/
public Builder mergeNestedField(io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage value) {
if (nestedFieldBuilder_ == null) {
if (nestedField_ != null) {
nestedField_ =
io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage.newBuilder(nestedField_).mergeFrom(value).buildPartial();
} else {
nestedField_ = value;
}
onChanged();
} else {
nestedFieldBuilder_.mergeFrom(value);
}
return this;
}
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage nested_field = 1;</code>
*/
public Builder clearNestedField() {
if (nestedFieldBuilder_ == null) {
nestedField_ = null;
onChanged();
} else {
nestedField_ = null;
nestedFieldBuilder_ = null;
}
return this;
}
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage nested_field = 1;</code>
*/
public io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage.Builder getNestedFieldBuilder() {
onChanged();
return getNestedFieldFieldBuilder().getBuilder();
}
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage nested_field = 1;</code>
*/
public io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessageOrBuilder getNestedFieldOrBuilder() {
if (nestedFieldBuilder_ != null) {
return nestedFieldBuilder_.getMessageOrBuilder();
} else {
return nestedField_ == null ?
io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage.getDefaultInstance() : nestedField_;
}
}
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage nested_field = 1;</code>
*/
private com.google.protobuf.SingleFieldBuilderV3<
io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage, io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage.Builder, io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessageOrBuilder>
getNestedFieldFieldBuilder() {
if (nestedFieldBuilder_ == null) {
nestedFieldBuilder_ = new com.google.protobuf.SingleFieldBuilderV3<
io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage, io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage.Builder, io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessageOrBuilder>(
getNestedField(),
getParentForChildren(),
isClean());
nestedField_ = null;
}
return nestedFieldBuilder_;
}
@java.lang.Override
public final Builder setUnknownFields(
final com.google.protobuf.UnknownFieldSet unknownFields) {
return super.setUnknownFields(unknownFields);
}
@java.lang.Override
public final Builder mergeUnknownFields(
final com.google.protobuf.UnknownFieldSet unknownFields) {
return super.mergeUnknownFields(unknownFields);
}
// @@protoc_insertion_point(builder_scope:io.bkbn.kompendium.protobufjavaconverter.NestedMessage)
}
// @@protoc_insertion_point(class_scope:io.bkbn.kompendium.protobufjavaconverter.NestedMessage)
private static final io.bkbn.kompendium.protobufjavaconverter.NestedMessage DEFAULT_INSTANCE;
static {
DEFAULT_INSTANCE = new io.bkbn.kompendium.protobufjavaconverter.NestedMessage();
}
public static io.bkbn.kompendium.protobufjavaconverter.NestedMessage getDefaultInstance() {
return DEFAULT_INSTANCE;
}
private static final com.google.protobuf.Parser<NestedMessage>
PARSER = new com.google.protobuf.AbstractParser<NestedMessage>() {
@java.lang.Override
public NestedMessage parsePartialFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return new NestedMessage(input, extensionRegistry);
}
};
public static com.google.protobuf.Parser<NestedMessage> parser() {
return PARSER;
}
@java.lang.Override
public com.google.protobuf.Parser<NestedMessage> getParserForType() {
return PARSER;
}
@java.lang.Override
public io.bkbn.kompendium.protobufjavaconverter.NestedMessage getDefaultInstanceForType() {
return DEFAULT_INSTANCE;
}
}

View File

@ -0,0 +1,24 @@
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: io/bkbn/kompendium/protobufjavaconverter/converters/test.proto
package io.bkbn.kompendium.protobufjavaconverter;
public interface NestedMessageOrBuilder extends
// @@protoc_insertion_point(interface_extends:io.bkbn.kompendium.protobufjavaconverter.NestedMessage)
com.google.protobuf.MessageOrBuilder {
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage nested_field = 1;</code>
* @return Whether the nestedField field is set.
*/
boolean hasNestedField();
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage nested_field = 1;</code>
* @return The nestedField.
*/
io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage getNestedField();
/**
* <code>.io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessage nested_field = 1;</code>
*/
io.bkbn.kompendium.protobufjavaconverter.SimpleTestMessageOrBuilder getNestedFieldOrBuilder();
}

View File

@ -0,0 +1,689 @@
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: io/bkbn/kompendium/protobufjavaconverter/converters/test.proto
package io.bkbn.kompendium.protobufjavaconverter;
/**
* Protobuf type {@code io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage}
*/
public final class RepeatedEnumMessage extends
com.google.protobuf.GeneratedMessageV3 implements
// @@protoc_insertion_point(message_implements:io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage)
RepeatedEnumMessageOrBuilder {
private static final long serialVersionUID = 0L;
// Use RepeatedEnumMessage.newBuilder() to construct.
private RepeatedEnumMessage(com.google.protobuf.GeneratedMessageV3.Builder<?> builder) {
super(builder);
}
private RepeatedEnumMessage() {
repeatedField_ = java.util.Collections.emptyList();
}
@java.lang.Override
@SuppressWarnings({"unused"})
protected java.lang.Object newInstance(
UnusedPrivateParameter unused) {
return new RepeatedEnumMessage();
}
@java.lang.Override
public final com.google.protobuf.UnknownFieldSet
getUnknownFields() {
return this.unknownFields;
}
private RepeatedEnumMessage(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
this();
if (extensionRegistry == null) {
throw new java.lang.NullPointerException();
}
int mutable_bitField0_ = 0;
com.google.protobuf.UnknownFieldSet.Builder unknownFields =
com.google.protobuf.UnknownFieldSet.newBuilder();
try {
boolean done = false;
while (!done) {
int tag = input.readTag();
switch (tag) {
case 0:
done = true;
break;
case 8: {
int rawValue = input.readEnum();
if (!((mutable_bitField0_ & 0x00000001) != 0)) {
repeatedField_ = new java.util.ArrayList<java.lang.Integer>();
mutable_bitField0_ |= 0x00000001;
}
repeatedField_.add(rawValue);
break;
}
case 10: {
int length = input.readRawVarint32();
int oldLimit = input.pushLimit(length);
while(input.getBytesUntilLimit() > 0) {
int rawValue = input.readEnum();
if (!((mutable_bitField0_ & 0x00000001) != 0)) {
repeatedField_ = new java.util.ArrayList<java.lang.Integer>();
mutable_bitField0_ |= 0x00000001;
}
repeatedField_.add(rawValue);
}
input.popLimit(oldLimit);
break;
}
default: {
if (!parseUnknownField(
input, unknownFields, extensionRegistry, tag)) {
done = true;
}
break;
}
}
}
} catch (com.google.protobuf.InvalidProtocolBufferException e) {
throw e.setUnfinishedMessage(this);
} catch (java.io.IOException e) {
throw new com.google.protobuf.InvalidProtocolBufferException(
e).setUnfinishedMessage(this);
} finally {
if (((mutable_bitField0_ & 0x00000001) != 0)) {
repeatedField_ = java.util.Collections.unmodifiableList(repeatedField_);
}
this.unknownFields = unknownFields.build();
makeExtensionsImmutable();
}
}
public static final com.google.protobuf.Descriptors.Descriptor
getDescriptor() {
return io.bkbn.kompendium.protobufjavaconverter.Test.internal_static_io_bkbn_kompendium_protobufjavaconverter_RepeatedEnumMessage_descriptor;
}
@java.lang.Override
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable() {
return io.bkbn.kompendium.protobufjavaconverter.Test.internal_static_io_bkbn_kompendium_protobufjavaconverter_RepeatedEnumMessage_fieldAccessorTable
.ensureFieldAccessorsInitialized(
io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage.class, io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage.Builder.class);
}
public static final int REPEATED_FIELD_FIELD_NUMBER = 1;
private java.util.List<java.lang.Integer> repeatedField_;
private static final com.google.protobuf.Internal.ListAdapter.Converter<
java.lang.Integer, io.bkbn.kompendium.protobufjavaconverter.Corpus> repeatedField_converter_ =
new com.google.protobuf.Internal.ListAdapter.Converter<
java.lang.Integer, io.bkbn.kompendium.protobufjavaconverter.Corpus>() {
public io.bkbn.kompendium.protobufjavaconverter.Corpus convert(java.lang.Integer from) {
@SuppressWarnings("deprecation")
io.bkbn.kompendium.protobufjavaconverter.Corpus result = io.bkbn.kompendium.protobufjavaconverter.Corpus.valueOf(from);
return result == null ? io.bkbn.kompendium.protobufjavaconverter.Corpus.UNRECOGNIZED : result;
}
};
/**
* <code>repeated .io.bkbn.kompendium.protobufjavaconverter.Corpus repeated_field = 1;</code>
* @return A list containing the repeatedField.
*/
@java.lang.Override
public java.util.List<io.bkbn.kompendium.protobufjavaconverter.Corpus> getRepeatedFieldList() {
return new com.google.protobuf.Internal.ListAdapter<
java.lang.Integer, io.bkbn.kompendium.protobufjavaconverter.Corpus>(repeatedField_, repeatedField_converter_);
}
/**
* <code>repeated .io.bkbn.kompendium.protobufjavaconverter.Corpus repeated_field = 1;</code>
* @return The count of repeatedField.
*/
@java.lang.Override
public int getRepeatedFieldCount() {
return repeatedField_.size();
}
/**
* <code>repeated .io.bkbn.kompendium.protobufjavaconverter.Corpus repeated_field = 1;</code>
* @param index The index of the element to return.
* @return The repeatedField at the given index.
*/
@java.lang.Override
public io.bkbn.kompendium.protobufjavaconverter.Corpus getRepeatedField(int index) {
return repeatedField_converter_.convert(repeatedField_.get(index));
}
/**
* <code>repeated .io.bkbn.kompendium.protobufjavaconverter.Corpus repeated_field = 1;</code>
* @return A list containing the enum numeric values on the wire for repeatedField.
*/
@java.lang.Override
public java.util.List<java.lang.Integer>
getRepeatedFieldValueList() {
return repeatedField_;
}
/**
* <code>repeated .io.bkbn.kompendium.protobufjavaconverter.Corpus repeated_field = 1;</code>
* @param index The index of the value to return.
* @return The enum numeric value on the wire of repeatedField at the given index.
*/
@java.lang.Override
public int getRepeatedFieldValue(int index) {
return repeatedField_.get(index);
}
private int repeatedFieldMemoizedSerializedSize;
private byte memoizedIsInitialized = -1;
@java.lang.Override
public final boolean isInitialized() {
byte isInitialized = memoizedIsInitialized;
if (isInitialized == 1) return true;
if (isInitialized == 0) return false;
memoizedIsInitialized = 1;
return true;
}
@java.lang.Override
public void writeTo(com.google.protobuf.CodedOutputStream output)
throws java.io.IOException {
getSerializedSize();
if (getRepeatedFieldList().size() > 0) {
output.writeUInt32NoTag(10);
output.writeUInt32NoTag(repeatedFieldMemoizedSerializedSize);
}
for (int i = 0; i < repeatedField_.size(); i++) {
output.writeEnumNoTag(repeatedField_.get(i));
}
unknownFields.writeTo(output);
}
@java.lang.Override
public int getSerializedSize() {
int size = memoizedSize;
if (size != -1) return size;
size = 0;
{
int dataSize = 0;
for (int i = 0; i < repeatedField_.size(); i++) {
dataSize += com.google.protobuf.CodedOutputStream
.computeEnumSizeNoTag(repeatedField_.get(i));
}
size += dataSize;
if (!getRepeatedFieldList().isEmpty()) { size += 1;
size += com.google.protobuf.CodedOutputStream
.computeUInt32SizeNoTag(dataSize);
}repeatedFieldMemoizedSerializedSize = dataSize;
}
size += unknownFields.getSerializedSize();
memoizedSize = size;
return size;
}
@java.lang.Override
public boolean equals(final java.lang.Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage)) {
return super.equals(obj);
}
io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage other = (io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage) obj;
if (!repeatedField_.equals(other.repeatedField_)) return false;
if (!unknownFields.equals(other.unknownFields)) return false;
return true;
}
@java.lang.Override
public int hashCode() {
if (memoizedHashCode != 0) {
return memoizedHashCode;
}
int hash = 41;
hash = (19 * hash) + getDescriptor().hashCode();
if (getRepeatedFieldCount() > 0) {
hash = (37 * hash) + REPEATED_FIELD_FIELD_NUMBER;
hash = (53 * hash) + repeatedField_.hashCode();
}
hash = (29 * hash) + unknownFields.hashCode();
memoizedHashCode = hash;
return hash;
}
public static io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage parseFrom(
java.nio.ByteBuffer data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage parseFrom(
java.nio.ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage parseFrom(
com.google.protobuf.ByteString data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage parseFrom(
com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage parseFrom(byte[] data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage parseFrom(
byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage parseFrom(java.io.InputStream input)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input);
}
public static io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage parseFrom(
java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input, extensionRegistry);
}
public static io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage parseDelimitedFrom(java.io.InputStream input)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseDelimitedWithIOException(PARSER, input);
}
public static io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage parseDelimitedFrom(
java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseDelimitedWithIOException(PARSER, input, extensionRegistry);
}
public static io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage parseFrom(
com.google.protobuf.CodedInputStream input)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input);
}
public static io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage parseFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input, extensionRegistry);
}
@java.lang.Override
public Builder newBuilderForType() { return newBuilder(); }
public static Builder newBuilder() {
return DEFAULT_INSTANCE.toBuilder();
}
public static Builder newBuilder(io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage prototype) {
return DEFAULT_INSTANCE.toBuilder().mergeFrom(prototype);
}
@java.lang.Override
public Builder toBuilder() {
return this == DEFAULT_INSTANCE
? new Builder() : new Builder().mergeFrom(this);
}
@java.lang.Override
protected Builder newBuilderForType(
com.google.protobuf.GeneratedMessageV3.BuilderParent parent) {
Builder builder = new Builder(parent);
return builder;
}
/**
* Protobuf type {@code io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage}
*/
public static final class Builder extends
com.google.protobuf.GeneratedMessageV3.Builder<Builder> implements
// @@protoc_insertion_point(builder_implements:io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage)
io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessageOrBuilder {
public static final com.google.protobuf.Descriptors.Descriptor
getDescriptor() {
return io.bkbn.kompendium.protobufjavaconverter.Test.internal_static_io_bkbn_kompendium_protobufjavaconverter_RepeatedEnumMessage_descriptor;
}
@java.lang.Override
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable() {
return io.bkbn.kompendium.protobufjavaconverter.Test.internal_static_io_bkbn_kompendium_protobufjavaconverter_RepeatedEnumMessage_fieldAccessorTable
.ensureFieldAccessorsInitialized(
io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage.class, io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage.Builder.class);
}
// Construct using io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage.newBuilder()
private Builder() {
maybeForceBuilderInitialization();
}
private Builder(
com.google.protobuf.GeneratedMessageV3.BuilderParent parent) {
super(parent);
maybeForceBuilderInitialization();
}
private void maybeForceBuilderInitialization() {
if (com.google.protobuf.GeneratedMessageV3
.alwaysUseFieldBuilders) {
}
}
@java.lang.Override
public Builder clear() {
super.clear();
repeatedField_ = java.util.Collections.emptyList();
bitField0_ = (bitField0_ & ~0x00000001);
return this;
}
@java.lang.Override
public com.google.protobuf.Descriptors.Descriptor
getDescriptorForType() {
return io.bkbn.kompendium.protobufjavaconverter.Test.internal_static_io_bkbn_kompendium_protobufjavaconverter_RepeatedEnumMessage_descriptor;
}
@java.lang.Override
public io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage getDefaultInstanceForType() {
return io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage.getDefaultInstance();
}
@java.lang.Override
public io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage build() {
io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage result = buildPartial();
if (!result.isInitialized()) {
throw newUninitializedMessageException(result);
}
return result;
}
@java.lang.Override
public io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage buildPartial() {
io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage result = new io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage(this);
int from_bitField0_ = bitField0_;
if (((bitField0_ & 0x00000001) != 0)) {
repeatedField_ = java.util.Collections.unmodifiableList(repeatedField_);
bitField0_ = (bitField0_ & ~0x00000001);
}
result.repeatedField_ = repeatedField_;
onBuilt();
return result;
}
@java.lang.Override
public Builder clone() {
return super.clone();
}
@java.lang.Override
public Builder setField(
com.google.protobuf.Descriptors.FieldDescriptor field,
java.lang.Object value) {
return super.setField(field, value);
}
@java.lang.Override
public Builder clearField(
com.google.protobuf.Descriptors.FieldDescriptor field) {
return super.clearField(field);
}
@java.lang.Override
public Builder clearOneof(
com.google.protobuf.Descriptors.OneofDescriptor oneof) {
return super.clearOneof(oneof);
}
@java.lang.Override
public Builder setRepeatedField(
com.google.protobuf.Descriptors.FieldDescriptor field,
int index, java.lang.Object value) {
return super.setRepeatedField(field, index, value);
}
@java.lang.Override
public Builder addRepeatedField(
com.google.protobuf.Descriptors.FieldDescriptor field,
java.lang.Object value) {
return super.addRepeatedField(field, value);
}
@java.lang.Override
public Builder mergeFrom(com.google.protobuf.Message other) {
if (other instanceof io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage) {
return mergeFrom((io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage)other);
} else {
super.mergeFrom(other);
return this;
}
}
public Builder mergeFrom(io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage other) {
if (other == io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage.getDefaultInstance()) return this;
if (!other.repeatedField_.isEmpty()) {
if (repeatedField_.isEmpty()) {
repeatedField_ = other.repeatedField_;
bitField0_ = (bitField0_ & ~0x00000001);
} else {
ensureRepeatedFieldIsMutable();
repeatedField_.addAll(other.repeatedField_);
}
onChanged();
}
this.mergeUnknownFields(other.unknownFields);
onChanged();
return this;
}
@java.lang.Override
public final boolean isInitialized() {
return true;
}
@java.lang.Override
public Builder mergeFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage parsedMessage = null;
try {
parsedMessage = PARSER.parsePartialFrom(input, extensionRegistry);
} catch (com.google.protobuf.InvalidProtocolBufferException e) {
parsedMessage = (io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage) e.getUnfinishedMessage();
throw e.unwrapIOException();
} finally {
if (parsedMessage != null) {
mergeFrom(parsedMessage);
}
}
return this;
}
private int bitField0_;
private java.util.List<java.lang.Integer> repeatedField_ =
java.util.Collections.emptyList();
private void ensureRepeatedFieldIsMutable() {
if (!((bitField0_ & 0x00000001) != 0)) {
repeatedField_ = new java.util.ArrayList<java.lang.Integer>(repeatedField_);
bitField0_ |= 0x00000001;
}
}
/**
* <code>repeated .io.bkbn.kompendium.protobufjavaconverter.Corpus repeated_field = 1;</code>
* @return A list containing the repeatedField.
*/
public java.util.List<io.bkbn.kompendium.protobufjavaconverter.Corpus> getRepeatedFieldList() {
return new com.google.protobuf.Internal.ListAdapter<
java.lang.Integer, io.bkbn.kompendium.protobufjavaconverter.Corpus>(repeatedField_, repeatedField_converter_);
}
/**
* <code>repeated .io.bkbn.kompendium.protobufjavaconverter.Corpus repeated_field = 1;</code>
* @return The count of repeatedField.
*/
public int getRepeatedFieldCount() {
return repeatedField_.size();
}
/**
* <code>repeated .io.bkbn.kompendium.protobufjavaconverter.Corpus repeated_field = 1;</code>
* @param index The index of the element to return.
* @return The repeatedField at the given index.
*/
public io.bkbn.kompendium.protobufjavaconverter.Corpus getRepeatedField(int index) {
return repeatedField_converter_.convert(repeatedField_.get(index));
}
/**
* <code>repeated .io.bkbn.kompendium.protobufjavaconverter.Corpus repeated_field = 1;</code>
* @param index The index to set the value at.
* @param value The repeatedField to set.
* @return This builder for chaining.
*/
public Builder setRepeatedField(
int index, io.bkbn.kompendium.protobufjavaconverter.Corpus value) {
if (value == null) {
throw new NullPointerException();
}
ensureRepeatedFieldIsMutable();
repeatedField_.set(index, value.getNumber());
onChanged();
return this;
}
/**
* <code>repeated .io.bkbn.kompendium.protobufjavaconverter.Corpus repeated_field = 1;</code>
* @param value The repeatedField to add.
* @return This builder for chaining.
*/
public Builder addRepeatedField(io.bkbn.kompendium.protobufjavaconverter.Corpus value) {
if (value == null) {
throw new NullPointerException();
}
ensureRepeatedFieldIsMutable();
repeatedField_.add(value.getNumber());
onChanged();
return this;
}
/**
* <code>repeated .io.bkbn.kompendium.protobufjavaconverter.Corpus repeated_field = 1;</code>
* @param values The repeatedField to add.
* @return This builder for chaining.
*/
public Builder addAllRepeatedField(
java.lang.Iterable<? extends io.bkbn.kompendium.protobufjavaconverter.Corpus> values) {
ensureRepeatedFieldIsMutable();
for (io.bkbn.kompendium.protobufjavaconverter.Corpus value : values) {
repeatedField_.add(value.getNumber());
}
onChanged();
return this;
}
/**
* <code>repeated .io.bkbn.kompendium.protobufjavaconverter.Corpus repeated_field = 1;</code>
* @return This builder for chaining.
*/
public Builder clearRepeatedField() {
repeatedField_ = java.util.Collections.emptyList();
bitField0_ = (bitField0_ & ~0x00000001);
onChanged();
return this;
}
/**
* <code>repeated .io.bkbn.kompendium.protobufjavaconverter.Corpus repeated_field = 1;</code>
* @return A list containing the enum numeric values on the wire for repeatedField.
*/
public java.util.List<java.lang.Integer>
getRepeatedFieldValueList() {
return java.util.Collections.unmodifiableList(repeatedField_);
}
/**
* <code>repeated .io.bkbn.kompendium.protobufjavaconverter.Corpus repeated_field = 1;</code>
* @param index The index of the value to return.
* @return The enum numeric value on the wire of repeatedField at the given index.
*/
public int getRepeatedFieldValue(int index) {
return repeatedField_.get(index);
}
/**
* <code>repeated .io.bkbn.kompendium.protobufjavaconverter.Corpus repeated_field = 1;</code>
* @param index The index of the value to return.
* @return The enum numeric value on the wire of repeatedField at the given index.
* @return This builder for chaining.
*/
public Builder setRepeatedFieldValue(
int index, int value) {
ensureRepeatedFieldIsMutable();
repeatedField_.set(index, value);
onChanged();
return this;
}
/**
* <code>repeated .io.bkbn.kompendium.protobufjavaconverter.Corpus repeated_field = 1;</code>
* @param value The enum numeric value on the wire for repeatedField to add.
* @return This builder for chaining.
*/
public Builder addRepeatedFieldValue(int value) {
ensureRepeatedFieldIsMutable();
repeatedField_.add(value);
onChanged();
return this;
}
/**
* <code>repeated .io.bkbn.kompendium.protobufjavaconverter.Corpus repeated_field = 1;</code>
* @param values The enum numeric values on the wire for repeatedField to add.
* @return This builder for chaining.
*/
public Builder addAllRepeatedFieldValue(
java.lang.Iterable<java.lang.Integer> values) {
ensureRepeatedFieldIsMutable();
for (int value : values) {
repeatedField_.add(value);
}
onChanged();
return this;
}
@java.lang.Override
public final Builder setUnknownFields(
final com.google.protobuf.UnknownFieldSet unknownFields) {
return super.setUnknownFields(unknownFields);
}
@java.lang.Override
public final Builder mergeUnknownFields(
final com.google.protobuf.UnknownFieldSet unknownFields) {
return super.mergeUnknownFields(unknownFields);
}
// @@protoc_insertion_point(builder_scope:io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage)
}
// @@protoc_insertion_point(class_scope:io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage)
private static final io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage DEFAULT_INSTANCE;
static {
DEFAULT_INSTANCE = new io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage();
}
public static io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage getDefaultInstance() {
return DEFAULT_INSTANCE;
}
private static final com.google.protobuf.Parser<RepeatedEnumMessage>
PARSER = new com.google.protobuf.AbstractParser<RepeatedEnumMessage>() {
@java.lang.Override
public RepeatedEnumMessage parsePartialFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return new RepeatedEnumMessage(input, extensionRegistry);
}
};
public static com.google.protobuf.Parser<RepeatedEnumMessage> parser() {
return PARSER;
}
@java.lang.Override
public com.google.protobuf.Parser<RepeatedEnumMessage> getParserForType() {
return PARSER;
}
@java.lang.Override
public io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage getDefaultInstanceForType() {
return DEFAULT_INSTANCE;
}
}

View File

@ -0,0 +1,38 @@
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: io/bkbn/kompendium/protobufjavaconverter/converters/test.proto
package io.bkbn.kompendium.protobufjavaconverter;
public interface RepeatedEnumMessageOrBuilder extends
// @@protoc_insertion_point(interface_extends:io.bkbn.kompendium.protobufjavaconverter.RepeatedEnumMessage)
com.google.protobuf.MessageOrBuilder {
/**
* <code>repeated .io.bkbn.kompendium.protobufjavaconverter.Corpus repeated_field = 1;</code>
* @return A list containing the repeatedField.
*/
java.util.List<io.bkbn.kompendium.protobufjavaconverter.Corpus> getRepeatedFieldList();
/**
* <code>repeated .io.bkbn.kompendium.protobufjavaconverter.Corpus repeated_field = 1;</code>
* @return The count of repeatedField.
*/
int getRepeatedFieldCount();
/**
* <code>repeated .io.bkbn.kompendium.protobufjavaconverter.Corpus repeated_field = 1;</code>
* @param index The index of the element to return.
* @return The repeatedField at the given index.
*/
io.bkbn.kompendium.protobufjavaconverter.Corpus getRepeatedField(int index);
/**
* <code>repeated .io.bkbn.kompendium.protobufjavaconverter.Corpus repeated_field = 1;</code>
* @return A list containing the enum numeric values on the wire for repeatedField.
*/
java.util.List<java.lang.Integer>
getRepeatedFieldValueList();
/**
* <code>repeated .io.bkbn.kompendium.protobufjavaconverter.Corpus repeated_field = 1;</code>
* @param index The index of the value to return.
* @return The enum numeric value on the wire of repeatedField at the given index.
*/
int getRepeatedFieldValue(int index);
}

Some files were not shown because too many files have changed in this diff Show More