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

Abierto
  • ¿Algo no está bien?
#25,574 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
65/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
java, php
Área
backend-api-design

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Java
Estrellas
26.9k
Forks
7.8k
Merge medio
2 d 10 h
PR fusionados (30 d)
180

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de OpenAPITools/openapi-generator

Todos los issues de OpenAPITools/openapi-generator

Issues similares

Más issues de Java

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.