[BUG][PHP] Nullable model reference in an array or map loses its namespace separators

未关闭
  • 哪里不对？
#25,574 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
65/100
Issue 类型
缺陷
描述清晰度
描述清楚
活跃度
活跃
技术栈
java, php
领域
backend-api-design

调研方向

Start by reading AbstractPhpCodegen.getTypeDeclaration(Schema) and compare how it handles a plain $ref with nullable oneOf, anyOf, and allOf references. Reproduce with the supplied OpenAPI spec using the PHP generator, then inspect lib/Model/Thing.php and the deserialization error. Done when the generated type includes \OpenAPI\Client\Model\Inner and both object and null map values deserialize.

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

描述

Bug Report Checklist
  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator?
  • Have you tested with the latest master to confirm the issue still exists?
  • Have you searched for related issues/PRs?
  • What's the actual output vs expected output?
Description

When an array item or a map value is a nullable reference to a model, the PHP client writes its type in $openAPITypes without namespace separators: array<string,\OpenAPIClientModelInner> or \OpenAPIClientModelInner[] instead of \OpenAPI\Client\Model\Inner, so ObjectSerializer::deserialize fails on every non-null value.

It happens with oneOf: [$ref, {type: "null"}], with the same anyOf, and with OpenAPI 3.0 allOf: [$ref] plus nullable: true. The type is correct for the same nullable reference as a plain property, for a plain $ref map value, and for a map of oneOf two models.

openapi-generator version

7.27.0, and master at d15b0164 (7.28.0-SNAPSHOT).

OpenAPI declaration file content or url
openapi: 3.1.0
info: {title: t, version: "1"}
paths:
  /things:
    get:
      responses: {"200": {description: ok, content: {application/json: {schema: {$ref: "#/components/schemas/Thing"}}}}}
components:
  schemas:
    Inner: {type: object, properties: {name: {type: string}}}
    Thing: {type: object, properties: {deps: {type: object, additionalProperties: {oneOf: [{$ref: "#/components/schemas/Inner"}, {type: "null"}]}}}}

validate reports no issues.

Generation Details
java -jar openapi-generator-cli.jar generate -g php -i spec.yaml -o out
Steps to reproduce

lib/Model/Thing.php has 'deps' => 'array<string,\OpenAPIClientModelInner>'. After composer install:

ObjectSerializer::deserialize(json_decode('{"deps": {"a": {"name": "x"}}}'), '\OpenAPI\Client\Model\Thing');
// Error: Class "\OpenAPIClientModelInner" not found

{"deps": {"a": null}} decodes. Expected: 'array<string,\OpenAPI\Client\Model\Inner>', and both values decode.

Related issues/PRs

#2011 is the same kind of wrong type string in $openAPITypes, from oneOf over two models.

Suggest a fix

AbstractPhpCodegen.getTypeDeclaration(Schema) prefixes \ + modelPackage only when the inner schema is a plain $ref. A nullable oneOf/anyOf/allOf around the ref falls through to super.getTypeDeclaration, and the separators are lost somewhere on that path. Unwrapping the nullable wrapper to its $ref before that check might fix it; I haven't tested a patch.

主要语言
Java
星标
26.9k
派生
7.8k
平均合并
2 天 10 小时
30 天内合并 PR
180

环境准备

在 Codespaces 中打开

在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。

从这里开始

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

OpenAPITools/openapi-generator 的其他 Issue

查看 OpenAPITools/openapi-generator 的全部 Issue

相似的 Issue

更多 Java Issue

把新 issue 发到你的邮箱

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