OpenAPITools / OpenAPITools/openapi-generator

[PHP] PHPdoc Enum types

Open
#12,331 4 comments 0 reactions 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

In the generated classes if an attribute is an enum, in its getter/setter, the phpdoc type is the class that contains the constants with the enum values instead of string:

enum class:

class Enum
{
    /**
     * Possible values of this enum
     */
    const FIRST = 'first';

    const SECOND = 'second';

Attribute setter(Enum type):

    /**
     * Sets type
     *
     * @param \Proj\Model\Enum|null $type type
     *
     * @return self
     */
    public function setType($type)
    {
        $this->container['type'] = $type;

        return $this;
    }

Here we set the property:

$obj->setType(Enum::FIRST);

As you can see the actual type passed is string and not Enum, so we will get a warning from the IDE.
So the phpdoc of the setter should be:

    /**
     * Sets type, see the accepted values in the Enum class
     *
     * @param string|null $type type
     *
     * @return self
     */
    public function setType($type)
    {
        $this->container['type'] = $type;

        return $this;
    }
openapi-generator version

5.4.0

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

No file or test is named in the issue. Start by locating the PHP generator's model and accessor template or entry point that produces enum property PHPDoc, then reproduce the example with a generated client. Done means enum-valued setters and getters document the passed value as string|null while retaining the enum class as the source of accepted constants.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.