OpenAPITools / OpenAPITools/openapi-generator

[REQ][typescript-fetch] Improve typing for generated ValidationAttributeMap objects

Open
#24,620 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement: Feature
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Is your feature request related to a problem? Please describe.

The current generation of the *ValidationAttributesMap objects generated the type as:

export const BauprogrammCreateDTOPropertyValidationAttributesMap: {
    [property: string]: {
        maxLength?: number,
        minLength?: number,
        pattern?: string,
        maximum?: number,
        exclusiveMaximum?: boolean,
        minimum?: number,
        exclusiveMinimum?: boolean,
        multipleOf?: number,
        maxItems?: number,
        minItems?: number,
        uniqueItems?: boolean
    }
} = { ... }

This makes the TS compiler unaware of the actual keys existent in the object and thus disabled auto completion and type safety when working with the *ValidationAttributesMap objects.

Describe the solution you'd like

I suggest to define a generic ValidationAttributes interface containing the type and removing the explicit type declaration from generated ValidationAttributeMaps. satisfies check would then keep the type safety for the Map objects themself intact.

Since ValidationAttributes would be a type thats not related to a specific model, the type should be defined centrally only once. (e.g. in runtime?)

Describe alternatives you've considered

--

Additional context

--

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 by locating the typescript-fetch templates or entry points that generate the *ValidationAttributesMap objects, then inspect how shared runtime types are organized. The work is done when generated maps retain their specific keys for autocomplete and type safety while validating against a centrally defined ValidationAttributes type.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.