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

オープン
  • 何か問題がありますか？
#25,574 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
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時間
マージ済み PR（30日）
180

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

OpenAPITools/openapi-generator のほかの issue

OpenAPITools/openapi-generator の issue をすべて見る

似ている issue

Java の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。