OpenAPITools / OpenAPITools/openapi-generator

[BUG][typescript] Using allOf, some types are misnamed

Open
#13,510 6 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?
Description

When using AllOf, certain requests get names that don't correspond to the context of their use, necessitating code that looks like this:

// PutRequest
return api.apiIRBsIrbControlIdUserUserNamePut({
    irbControlId,
    userName,
    // DeleteRequest???
    apiIRBsIrbControlIdGroupGroupNameDeleteRequest: { role },
  });

Aesthetically, the name of the field is strange and overly long (anything i can do there?) but more importantly, it is pulled from the wrong place. It should be apiIRBsIrbControlIdUserUserNamePutRequest not apiIRBsIrbControlIdGroupGroupNameDeleteRequest.

openapi-generator version

6.1.0 (corrected typo, was 6.0.1)

OpenAPI declaration file content or url

https://gist.github.com/MattiasMartens/23fcb15c23a10f9c624d20d71e6d8cbd

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 TypeScript client generation with OpenAPI Generator 6.1.0 using the OpenAPI declaration in the linked gist, then compare the generated allOf request field names with the expected name in the report. Done means the request field uses the operation context shown in the issue rather than the unrelated delete-request name.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, typescript
Domain
api, tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 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.