OpenAPITools / OpenAPITools/openapi-generator

[BUG] operationIdNameMappings in openapi-generator-maven-plugin do not work

Open
#21,224 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

operationIdNameMappings in openapi-generator-maven-plugin do not replace operationIDs

openapi-generator version

7.13.0

OpenAPI declaration file content or url

openapi_signature_v1.json

Generation Details

getDocumentaryTypes is generated as getDocumentaryTypesOnServer and getDocumentaryTypesDirectOnWeb, and it should be "getDocumentaryTypes" in both cases

Steps to reproduce

Create a same method in two services with two operationID. You add operationIdNameMappings in openapi-generator-maven-plugin to generate the service client with same name. The methods names generated in the client are the originals, and it should be the defined one in operationIdNameMappings

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

Start with the openapi-generator-maven-plugin handling of operationIdNameMappings and reproduce the report using the attached openapi_signature_v1.json specification. Trace how mapped operation IDs are passed into generation for duplicate operations. Done means both generated methods use the configured name getDocumentaryTypes rather than the original suffixed names.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi
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.