OpenAPITools / OpenAPITools/openapi-generator

[BUG][typescript-angular] additional property useSquareBracketsInArrayNames does not work

Open
#20,374 0 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

The "useSquareBracketsInArrayNames" parameter has no effect. Adding brackets to array attribute names does not occur.

openapi-generator version

7.10.0

Steps to reproduce
"generator-cli": {
    "version": "7.10.0",
    "generators": {
      "angular": {
        "generatorName": "typescript-angular",
        "output": "gen/api/#{name}",
        "glob": "swagger/*.json",
        "additionalProperties": {
          "ngVersion": "19.0.0",
          "apiModulePrefix": "#{Name}",
          "allowUnicodeIdentifiers": true,
          "fileNaming": "kebab-case",
          "providedIn": "root",
          "serviceFileSuffix": ".api.client",
          "serviceSuffix": "ApiClient",
          "supportsES6": true,
          "useSquareBracketsInArrayNames": true,
          "prefixParameterInterfaces": true,
          "useSingleRequestParameter": true
        },
        "skipValidateSpec": true
      }
    }
  }
Expected

Query Params:

  • pageIndex: 0
  • pageNumber: 10
  • statuses[]: SAVED
  • statuses[]: CANCELED
Received

Query Params:

  • pageIndex: 0
  • pageNumber: 10
  • statuses: SAVED
  • statuses: CANCELED

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 typescript-angular generator and its handling of the useSquareBracketsInArrayNames additional property. Reproduce the issue using the generator-cli configuration and compare the generated query parameter names with the expected statuses[] form. Done means array parameters are emitted with square brackets when the property is true.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.