OpenAPITools / OpenAPITools/openapi-generator

[BUG][typescript-angular] PropertyNames on dictionaries are ignored

Open
#19,433 1 comment 2 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

Description

If an object has a property that specifies additionalProperties and propertyNames then propertyNames is not taken into account when generating the interface.

openapi-generator version

7.8.0

OpenAPI declaration file content or url
components:
  schema:
    SomeDTO:
      map:
        type: object
        additionalProperties:
          type: array
          items:
            $ref: '#/components/schemas/OtherDTO'
        propertyNames:
          type: string
          enum:
          - FOO
          - BAR
Generation Details

Generated using: openapi-generator-maven-plugin

Configuration:

<typeMappings>
  <typeMapping>DateTime=string</typeMapping>
</typeMappings>

<configOptions>
  <ngVersion>17.3.11</ngVersion>
</configOptions>

Steps to reproduce

Run the generation and check the generated interface

expected output:

interface SomeDTO {
  map: {
    foo: Array<OtherDTO>;
    bar: Array<OtherDTO>;
    [key: string]: Array<OtherDTO>;
  }
}

actual output:

interface SomeDTO {
  map: { [key: string]: Array<OtherDTO>; }
}

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 YAML declaration and openapi-generator-maven-plugin configuration, then inspect the generated TypeScript interface for SomeDTO. Compare the output with the expected interface and verify that the propertyNames enum values and the index signature are both represented.

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
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.