Skip to content

[kotlin-server][JAX-RS] Fix class names for useTags#23441

Open
feczkob wants to merge 2 commits intoOpenAPITools:masterfrom
feczkob:fix/useTags-classnames
Open

[kotlin-server][JAX-RS] Fix class names for useTags#23441
feczkob wants to merge 2 commits intoOpenAPITools:masterfrom
feczkob:fix/useTags-classnames

Conversation

@feczkob
Copy link
Copy Markdown
Contributor

@feczkob feczkob commented Apr 2, 2026

Follow-up of #23379.
Fixes #23414

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Summary by cubic

Fixes JAX-RS kotlin-server class naming and @Path generation when useTags is false or omitted, and consistently applies class-level common paths across JAX-RS. Operations are grouped by the first path segment with a class-level base path and trimmed method paths.

  • Bug Fixes
    • JAX-RS (jaxrs-spec): when useTags=false or missing, group operations by base path; fall back to default if the base path is empty or templated.
    • Compute commonPath for all JAX-RS classes; set class-level @Path to it (empty for root) and emit method @Path only for sub-resources.
    • Update templates: docs now use {{commonPath}}{{path}}; JAX-RS interface renders method @Path only when needed.
    • Update tests, configs, and regenerated samples to reflect correct class names and paths.

Written for commit 7a365ce. Summary will update on new commits.

Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 14 files

@feczkob
Copy link
Copy Markdown
Contributor Author

feczkob commented Apr 2, 2026

I used this repo for reproduction, thanks to @lbilger: https://github.com/lbilger/openapi-generator-path-shadowing-reproducer

JAXRS-SPEC, useTags = true

image

kotlin-server, JAXRS-SPEC, useTags = true

image

JAXRS-SPEC, useTags = false

image

kotlin-server, JAXRS-SPEC, useTags = false

image

JAXRS-SPEC, no useTags

image

kotlin-server, JAXRS-SPEC, no useTags

image

@feczkob feczkob force-pushed the fix/useTags-classnames branch from 945ed35 to 7a365ce Compare April 2, 2026 14:39
Copy link
Copy Markdown
Contributor

@lbilger lbilger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@feczkob I think I see more or less what you're doing here now. You want to align kotlin-server/jaxrs-spec with the "original" jaxrs-spec. If that is the main goal, the PR mostly achieves it as far as I can see. Only the docs should also state that the useTags parameter is only supported for this library, just like useMutiny already does.

This will however be a breaking change for everyone using this generator/library. Also, it deliberately excludes all the other libraries from using this parameter even though it would be no additional effort to support it for all libraries. So I suggest to at least consider making useTags=true the default, even though it is not completely in line with jaxrs-spec.

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{classname}}* | [**{{operationId}}**]({{apiDocPath}}{{classname}}.md#{{operationIdLowerCase}}) | **{{httpMethod}}** {{#useTags}}{{commonPath}}{{/useTags}}{{path}} | {{{summary}}}
{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{classname}}* | [**{{operationId}}**]({{apiDocPath}}{{classname}}.md#{{operationIdLowerCase}}) | **{{httpMethod}}** {{commonPath}}{{path}} | {{{summary}}}
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems operationIdLowerCase is not set in the useTags=false case - probably because the super method that sets it is never called.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG][kotlin-server] Common path prefix extraction breaks cross-tag JAX-RS routing

2 participants