OpenAPITools / OpenAPITools/openapi-generator

[BUG] [javascript-flowtyped] Array alias is not generated properly in oneOf

Open
#6,015 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Client: JavaScript/Node.js 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)?
  • What's the version of OpenAPI Generator used?
  • Have you search for related issues/PRs?
  • What's the actual output vs expected output?
Description

If an alternative of oneOf is an array type, the generated Array type will miss a required type argument.

openapi-generator version

4.3.0

OpenAPI declaration file content or url
openapi: '3.0.0'
info:
  version: 0.0.0
  title: Bug
paths:
  /bug:
    get:
      responses:
        default:
          $ref: '#/components/responses/Response'
components:
  responses:
    Response:
      description: response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Record'
  schemas:
    Record:
      properties:
        property:
          type: array
          items:
            oneOf:
              - $ref: '#/components/schemas/Element'
              - $ref: '#/components/schemas/List'
    Element:
      properties:
        foo:
          type: integer
          format: int64
          example: 1
    List:
      type: array
      items:
        type: string
Command line used for generation

openapi-generator generate -i bug.yaml -g javascript-flowtyped -o bug/

Steps to reproduce
  • Generate code with the above command line
  • Check the generated code with flow check bug
  • You get
Cannot use type without exactly 1 type argument.

     93│      * @type {Array<Element | Array>}
     94│      * @memberof Record
     95│      */
     96│     property?: Array<Element | Array>;
     97│ }
     98│
     99│

because Array requires a type argument.

Related issues/PRs

I found none.

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

Use the OpenAPI declaration in bug.yaml and run the documented openapi-generator command with the javascript-flowtyped generator. Inspect the generated Record property type and run flow check on the bug output; done means the oneOf array alternative has a valid element type argument and Flow reports no missing-type-argument error.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.