Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

[Schema Inaccuracy] Server fails to send 'slug' and 'name' fields for InstallationAccount, but in the generated code they're mandatory.

未关闭
#4,651 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
55/100
Issue 类型
缺陷
描述清晰度
描述清楚
活跃度
停滞
技术栈
kotlin
领域
api

调研方向

受影响的 schema 是 components.schemas.enterprise.required,可通过 /app/installations 响应及其 installation account union 访问。首先检查列出的 remoteInputSpec 中的 GHES 3.12 OpenAPI 输入,然后确认生成的 model/InstallationAccount.kt 不再要求 name 和 slug。完成标准是 appsListInstallations 能够在不出现 MissingFieldException 的情况下反序列化该响应。

由索引模型根据 Issue 内容生成。

描述

documentation inaccuracy

Schema Inaccuracy

Server fails to send 'slug' and 'name' fields for model/InstallationAccount.kt, but in the generated code they're mandatory.

Expected

Fields 'slug' and 'name' for InstallationAccount should be optional, according to the server response, but not the Kotlin generated code.

These seem to need changing:
components.schemas.enterprise.required - remove (name, slug)

paths./app/installations.responses.200 refers to components/schemas/installation which has a union:

          "account": {
            "nullable": true,
            "anyOf": [
              {
                "$ref": "#/components/schemas/simple-user"
              },
              {
                "$ref": "#/components/schemas/enterprise"
              }
            ]
          },

Reproduction Steps

I'm calling AppsApi().appsListInstallations() and getting an exception from my Enterprise server: GitHub Enterprise Server 3.12.8

Caused by: kotlinx.serialization.MissingFieldException: Fields [name, slug] are required for type with serial name 'com.bumble.sdlc.github.model.InstallationAccount', but they were missing

I've looked at the response json, and they are indeed missing.

If I add ? to make them nullable, this particular issue is fixed.

remoteInputSpec = "https://raw.githubusercontent.com/github/rest-api-description/refs/heads/main/descriptions/ghes-3.12/ghes-3.12.json"

openapi-generator/.config:
{
    "library": "jvm-ktor",
    "dateLibrary": "java8",
    "serializationLibrary": "kotlinx_serialization",
    "enumPropertyNaming": "UPPERCASE",
    "omitGradleWrapper": "true",
    "omitGradlePluginVersions": "true"
}
Exception in thread "main" io.ktor.serialization.JsonConvertException: Illegal input: Fields [name, slug] are required for type with serial name 'com.bumble.sdlc.github.model.InstallationAccount', but they were missing at path: $[0].account
	at io.ktor.serialization.kotlinx.KotlinxSerializationConverter.deserialize(KotlinxSerializationConverter.kt:77)
	at io.ktor.serialization.ContentConverterKt$deserialize$$inlined$map$1$2.emit(Emitters.kt:51)
	at kotlinx.coroutines.flow.FlowKt__BuildersKt$asFlow$$inlined$unsafeFlow$3.collect(SafeCollector.common.kt:111)
	at io.ktor.serialization.ContentConverterKt$deserialize$$inlined$map$1.collect(SafeCollector.common.kt:109)
	at kotlinx.coroutines.flow.FlowKt__ReduceKt.firstOrNull(Reduce.kt:247)
	at kotlinx.coroutines.flow.FlowKt.firstOrNull(Unknown Source)
	at io.ktor.serialization.ContentConverterKt.deserialize(ContentConverter.kt:99)
	at io.ktor.client.plugins.contentnegotiation.ContentNegotiationKt.ContentNegotiation$lambda$13$convertResponse(ContentNegotiation.kt:234)
	at io.ktor.client.plugins.contentnegotiation.ContentNegotiationKt.access$ContentNegotiation$lambda$13$convertResponse(ContentNegotiation.kt:1)
	at io.ktor.client.plugins.contentnegotiation.ContentNegotiationKt$ContentNegotiation$2$2.invokeSuspend(ContentNegotiation.kt:249)
	at io.ktor.client.plugins.contentnegotiation.ContentNegotiationKt$ContentNegotiation$2$2.invoke(ContentNegotiation.kt)
	at io.ktor.client.plugins.contentnegotiation.ContentNegotiationKt$ContentNegotiation$2$2.invoke(ContentNegotiation.kt)
	at io.ktor.client.plugins.api.TransformResponseBodyHook$install$1.invokeSuspend(KtorCallContexts.kt:105)
	at io.ktor.client.plugins.api.TransformResponseBodyHook$install$1.invoke(KtorCallContexts.kt)
	at io.ktor.client.plugins.api.TransformResponseBodyHook$install$1.invoke(KtorCallContexts.kt)
	at io.ktor.util.pipeline.DebugPipelineContext.proceedLoop(DebugPipelineContext.kt:79)
	at io.ktor.util.pipeline.DebugPipelineContext.proceed(DebugPipelineContext.kt:57)
	at io.ktor.client.HttpClient$4.invokeSuspend(HttpClient.kt:1379)
	at io.ktor.client.HttpClient$4.invoke(HttpClient.kt)
	at io.ktor.client.HttpClient$4.invoke(HttpClient.kt)
	at io.ktor.util.pipeline.DebugPipelineContext.proceedLoop(DebugPipelineContext.kt:79)
	at io.ktor.util.pipeline.DebugPipelineContext.proceed(DebugPipelineContext.kt:57)
	at io.ktor.client.plugins.logging.ReceiveHook$Context.proceed(Logging.kt:290)
	at io.ktor.client.plugins.logging.LoggingKt$Logging$2$3.invokeSuspend(Logging.kt:209)
	at io.ktor.client.plugins.logging.LoggingKt$Logging$2$3.invoke(Logging.kt)
	at io.ktor.client.plugins.logging.LoggingKt$Logging$2$3.invoke(Logging.kt)
	at io.ktor.client.plugins.logging.ReceiveHook$install$1.invokeSuspend(Logging.kt:298)
	at io.ktor.client.plugins.logging.ReceiveHook$install$1.invoke(Logging.kt)
	at io.ktor.client.plugins.logging.ReceiveHook$install$1.invoke(Logging.kt)
	at io.ktor.util.pipeline.DebugPipelineContext.proceedLoop(DebugPipelineContext.kt:79)
	at io.ktor.util.pipeline.DebugPipelineContext.proceed(DebugPipelineContext.kt:57)
	at io.ktor.client.plugins.ReceiveError$install$1.invokeSuspend(HttpCallValidator.kt:149)
	at io.ktor.client.plugins.ReceiveError$install$1.invoke(HttpCallValidator.kt)
	at io.ktor.client.plugins.ReceiveError$install$1.invoke(HttpCallValidator.kt)
	at io.ktor.util.pipeline.DebugPipelineContext.proceedLoop(DebugPipelineContext.kt:79)
	at io.ktor.util.pipeline.DebugPipelineContext.proceed(DebugPipelineContext.kt:57)
	at io.ktor.util.pipeline.DebugPipelineContext.execute$ktor_utils(DebugPipelineContext.kt:63)
	at io.ktor.util.pipeline.Pipeline.execute(Pipeline.kt:79)
	at io.ktor.client.call.HttpClientCall.bodyNullable(HttpClientCall.kt:86)
	at com.bumble.sdlc.github.api.AppsApi.appsListInstallations(AppsApi.kt:1014)
	at com.bumble.sdlc.github.api.AppsApi$appsListInstallations$1.invokeSuspend(AppsApi.kt)
	at kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(ContinuationImpl.kt:33)
	at kotlinx.coroutines.DispatchedTask.run(DispatchedTask.kt:100)
	at kotlinx.coroutines.EventLoopImplBase.processNextEvent(EventLoop.common.kt:263)
	at kotlinx.coroutines.BlockingCoroutine.joinBlocking(Builders.kt:95)
	at kotlinx.coroutines.BuildersKt__BuildersKt.runBlocking(Builders.kt:69)
	at kotlinx.coroutines.BuildersKt.runBlocking(Unknown Source)
	at kotlinx.coroutines.BuildersKt__BuildersKt.runBlocking$default(Builders.kt:47)
	at kotlinx.coroutines.BuildersKt.runBlocking$default(Unknown Source)
	at com.bumble.sdlc.github.client.GitHubMultiClientKt.main(GitHubMultiClient.kt:80)
	at com.bumble.sdlc.github.client.GitHubMultiClientKt.main(GitHubMultiClient.kt)
Caused by: kotlinx.serialization.MissingFieldException: Fields [name, slug] are required for type with serial name 'com.bumble.sdlc.github.model.InstallationAccount', but they were missing at path: $[0].account
	at kotlinx.serialization.json.internal.StreamingJsonDecoder.decodeSerializableValue(StreamingJsonDecoder.kt:95)
	at kotlinx.serialization.encoding.AbstractDecoder.decodeSerializableValue(AbstractDecoder.kt:43)
	at kotlinx.serialization.encoding.AbstractDecoder.decodeNullableSerializableElement(AbstractDecoder.kt:78)
	at com.bumble.sdlc.github.model.Installation$$serializer.deserialize(Installation.kt:35)
	at com.bumble.sdlc.github.model.Installation$$serializer.deserialize(Installation.kt:35)
	at kotlinx.serialization.json.internal.StreamingJsonDecoder.decodeSerializableValue(StreamingJsonDecoder.kt:69)
	at kotlinx.serialization.encoding.AbstractDecoder.decodeSerializableValue(AbstractDecoder.kt:43)
	at kotlinx.serialization.encoding.AbstractDecoder.decodeSerializableElement(AbstractDecoder.kt:70)
	at kotlinx.serialization.json.internal.StreamingJsonDecoder.decodeSerializableElement(StreamingJsonDecoder.kt:168)
	at kotlinx.serialization.encoding.CompositeDecoder$DefaultImpls.decodeSerializableElement$default(Decoding.kt:538)
	at kotlinx.serialization.internal.CollectionLikeSerializer.readElement(CollectionSerializers.kt:80)
	at kotlinx.serialization.internal.AbstractCollectionSerializer.readElement$default(CollectionSerializers.kt:51)
	at kotlinx.serialization.internal.AbstractCollectionSerializer.merge(CollectionSerializers.kt:36)
	at kotlinx.serialization.internal.AbstractCollectionSerializer.deserialize(CollectionSerializers.kt:43)
	at kotlinx.serialization.json.internal.StreamingJsonDecoder.decodeSerializableValue(StreamingJsonDecoder.kt:69)
	at kotlinx.serialization.json.Json.decodeFromString(Json.kt:165)
	at io.ktor.serialization.kotlinx.KotlinxSerializationConverter.deserialize(KotlinxSerializationConverter.kt:69)
	... 50 more
Caused by: kotlinx.serialization.MissingFieldException: Fields [name, slug] are required for type with serial name 'com.bumble.sdlc.github.model.InstallationAccount', but they were missing
	at kotlinx.serialization.internal.PluginExceptionsKt.throwMissingFieldException(PluginExceptions.kt:20)
	at com.bumble.sdlc.github.model.InstallationAccount.<init>(InstallationAccount.kt:40)
	at com.bumble.sdlc.github.model.InstallationAccount$$serializer.deserialize(InstallationAccount.kt:40)
	at com.bumble.sdlc.github.model.InstallationAccount$$serializer.deserialize(InstallationAccount.kt:40)
	at kotlinx.serialization.json.internal.StreamingJsonDecoder.decodeSerializableValue(StreamingJsonDecoder.kt:69)
	... 66 more
主要语言
没有语言数据
星标
1.6k
派生
345
平均合并
6 小时
30 天内合并 PR
82

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

github/rest-api-description 的其他 Issue

查看 github/rest-api-description 的全部 Issue

相似的 Issue

更多 Backend & API Design Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。