OpenAPITools / OpenAPITools/openapi-generator

[BUG] [Php] Incorrect response type handling for oneOf strategy

Open
#11,680 4 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Bug Report Checklist
  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • 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?
  • [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description
openapi-generator version

5.4.0

OpenAPI declaration file content
"inputFieldDependencies": {
    "type": "array",
    "description": "",
    "items": {
        "oneOf": [
            {
                "$ref": "#/components/schemas/SingleFieldDependency"
            },
            {
                "$ref": "#/components/schemas/ConditionalSingleFieldDependency"
            }
        ]
    }
}
Generation Details

generate -i *.json -g php -o /dir --skip-validate-spec

Output
protected static $openAPITypes = [
        'input_field_dependencies' => 'OneOfSingleFieldDependencyConditionalSingleFieldDependency[]',
    ];
        /**
     * Gets input_field_dependencies
     *
     * @return OneOfSingleFieldDependencyConditionalSingleFieldDependency[]|null
     */
    public function getInputFieldDependencies()
    {
        return $this->container['input_field_dependencies'];
    }

    /**
     * Sets input_field_dependencies
     *
     * @param OneOfSingleFieldDependencyConditionalSingleFieldDependency[]|null $input_field_dependencies A list of dependencies between the input fields. These configure when the input fields should be visible.
     *
     * @return self
     */
    public function setInputFieldDependencies($input_field_dependencies)
    {
        $this->container['input_field_dependencies'] = $input_field_dependencies;

        return $this;
    }
Suggest a fix

Create oneOf strategy for php

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the generate -i *.json -g php command and the supplied inputFieldDependencies schema containing a oneOf array. Inspect how the PHP generator derives the displayed response type, then compare generated output with the intended separate oneOf handling; done means the generated PHP types and accessors represent the schema correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.