OpenAPITools / OpenAPITools/openapi-generator

[BUG][typescript-angular] [5.4.0] Array with inline object not generated correctly

Open
#11,528 0 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

When generating the json the array type is not generated correctly.

 public getList(observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable<Array<object>>;

Object is wrong should be the Item defined in the array

openapi-generator version

My version is 5.4.0:

OpenAPI declaration file content or url

Example file
--> https://gist.github.com/Nightapes/12c38ee1ad6988232e707c49ad5575b4

Generation Details
{
  "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json",
  "spaces": 2,
  "generator-cli": {
    "version": "5.4.0",
    "generators": {
      "treno": {
        "generatorName": "typescript-angular",
        "glob": "../api.treno.finance/apps/treno-api/openapi.json",
        "output": "libs/main-app/api/src/lib/generated",
        "additionalProperties": {
          "supportsES6": true,
          "stringEnums": true,
          "ngVersion": "13.0.1",
          "providedInRoot": true,
          "disallowAdditionalPropertiesIfNotPresent": false,
          "enumPropertyNaming": "UPPERCASE",
          "enumNameSuffix": "",
          "fileNaming": "kebab-case"
        }
      }
    }
  }
}

Steps to reproduce

Use example and generate lib

Related issues/PRs
Suggest a fix

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

Reproduce the issue with the OpenAPI example linked in the report and the generator-cli configuration for the typescript-angular generator. Inspect the generated client under libs/main-app/api/src/lib/generated, focusing on the getList method signature. Done means the array uses the item type defined by the OpenAPI declaration instead of object.

Written by the indexing model from the issue text.

Assessment

Tech stack
angular, openapi, typescript
Domain
api, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.