Skip to content
GitLab
    • Explore Projects Groups Snippets
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • O openapi-generator
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3,476
    • Issues 3,476
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 402
    • Merge requests 402
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • OpenAPI Tools
  • openapi-generator
  • Merge requests
  • !13021

bugfix: java @ApiResponse is now correctly using default responseCode and not falling back to 200

  • Review changes

  • Download
  • Email patches
  • Plain diff
Open Administrator requested to merge github/fork/PirvuCatalin/bug/java-default-apireponse-code into master 2 years ago
  • Overview 1
  • Commits 1
  • Pipelines 1
  • Changes 1

Created by: PirvuCatalin

According to https://spec.openapis.org/oas/v3.1.0#responses-object-example, it's possible to define both "200" and "default" possible responses. Unfortunately, the openapi-generator-cli for java code is incorrectly mapping "default" to "200" and not taking into account the fact that io.swagger.v3.oas.annotations.responses.ApiResponse also has a "default" value.

Currently, if you have an openapi file which defines cases "200" and "default", it will generate something as following:

 @Override
    @Operation(
            operationId = "getMethod1",
            tags = {"Method"},
            responses = {
                    @ApiResponse(responseCode = "200", description = "successful operation", content = {
                            @Content(mediaType = "application/json", schema = @Schema(implementation = Method1.class))
                    }),
                    @ApiResponse(responseCode = "200", description = "Error getting response", content = {
                            @Content(mediaType = "application/json", schema = @Schema(implementation = ErrorResponse.class))
                    })
            }
    )

, which obviously is incorrect (notice the duplicated responseCode). This PR is fixing that issue for java. There is a similar issue mentioned at https://github.com/OpenAPITools/openapi-generator/issues/12481 for python-fastapi and I might also fix that if I get a positive feedback on this PR.

TC mentions: @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10)

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 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    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*. For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (6.1.0) (minor release - breaking changes with fallbacks), 7.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
Compare
  • version 1
    0fe66ceb
    2 years ago

  • master (base)

and
  • latest version
    0fe66ceb
    1 commit, 2 years ago

  • version 1
    0fe66ceb
    1 commit, 2 years ago

1 file
+ 1
- 1

    Preferences

    File browser
    Compare changes
modules/openapi-generator/src/main/resources/JavaSpring/api.mustache
+ 1
- 1
  • View file @ 0fe66ceb

  • Edit in single-file editor

  • Open in Web IDE


Conflict: This file was modified in both the source and target branches. Ask someone with write access to resolve it.
@@ -154,7 +154,7 @@ public interface {{classname}} {
{{/vendorExtensions.x-tags.size}}
responses = {
{{#responses}}
@ApiResponse(responseCode = "{{{code}}}", description = "{{{message}}}"{{#baseType}}, content = {
@ApiResponse(responseCode = "{{#isDefault}}default{{/isDefault}}{{^isDefault}}{{{code}}}{{/isDefault}}", description = "{{{message}}}"{{#baseType}}, content = {
{{#produces}}
@Content(mediaType = "{{{mediaType}}}", schema = @Schema(implementation = {{{baseType}}}.class)){{^-last}},{{/-last}}
{{/produces}}
0 Assignees
None
Assign to
0 Reviewers
None
Request review from
Labels
0
None
0
None
    Assign labels
  • Manage project labels

Milestone
No milestone
None
None
Time tracking
No estimate or time spent
Lock merge request
Unlocked
1
1 participant
Administrator
Reference: OpenAPITools/openapi-generator!13021
Source branch: github/fork/PirvuCatalin/bug/java-default-apireponse-code

Menu

Explore Projects Groups Snippets