Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Issue 18224 - Load x-field-extra-annotation in the operation parameter #18967

Merged
merged 7 commits into from
Jun 30, 2024

Conversation

rodrigoma3
Copy link
Contributor

@rodrigoma3 rodrigoma3 commented Jun 18, 2024

Load x-field-extra-annotation in the operation parameter
Unit test to verify that the API loaded the annotation
fix #18224

Depends on #18962

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/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    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.6.0 minor release - breaking changes with fallbacks), 8.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.

@cachescrubber (2022/02) @welshm (2022/02) @MelleD (2022/02) @atextor (2022/02) @manedev79 (2022/02) @javisst (2022/02) @borsch (2022/02) @banlevente (2022/02) @Zomzog (2022/09) @wing328

@rodrigoma3
Copy link
Contributor Author

@wing328 @welshm @borsch

Copy link
Contributor

@welshm welshm left a comment

Choose a reason for hiding this comment

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

LGTM from spring perspective.

Do you want to update or add a sample to show what the generated code looks like?

@rodrigoma3
Copy link
Contributor Author

LGTM from spring perspective.

Do you want to update or add a sample to show what the generated code looks like?

Generated code follows:

/**
     * POST /test/{groupObj} : Post to test
     * 
     *
     * @param groupObj  (required)
     * @param token  (required)
     * @param clientId  (required)
     * @param objTest  (optional)
     * @return success (status code 201)
     */
    @Operation(
        operationId = "postToTest",
        summary = "Post to test",
        description = "",
        responses = {
            @ApiResponse(responseCode = "201", description = "success")
        }
    )
    @RequestMapping(
        method = RequestMethod.POST,
        value = "/test/{groupObj}",
        consumes = { "application/json" }
    )
    @ResponseStatus(HttpStatus.CREATED)
    
    default void _postToTest(
        @com.test.MyAnnotationInPath@Pattern(regexp = "[a-zA-Z]", message="Only letters") @Parameter(name = "groupObj", description = "", required = true, in = ParameterIn.PATH) @PathVariable("groupObj") String groupObj,
        @com.test.MyAnnotationInQuery@NotNull @Pattern(regexp = "[0-9a-fA-F]", message="Only numbers and letters a-f") @Parameter(name = "token", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "token", required = true) String token,
        @com.test.MyAnnotationInHeader@NotNull @Pattern(regexp = "\\d", message="Only numbers") @Parameter(name = "clientId", description = "", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "clientId", required = true) String clientId,
        @Parameter(name = "ObjTest", description = "") @Valid @RequestBody(required = false) ObjTest objTest
    ) {
        postToTest(groupObj, token, clientId, objTest);
    }

Rodrigo Maciel de Almeida added 2 commits June 21, 2024 09:42
@rodrigoma3
Copy link
Contributor Author

I added a spacing correction between the x-field-extra-annotation. Here's how it turned out.

/**
     * POST /test/{groupObj} : Post to test
     * 
     *
     * @param groupObj  (required)
     * @param token  (required)
     * @param clientId  (required)
     * @param objTest  (optional)
     * @return success (status code 201)
     */
    @Operation(
        operationId = "postToTest",
        summary = "Post to test",
        description = "",
        responses = {
            @ApiResponse(responseCode = "201", description = "success")
        }
    )
    @RequestMapping(
        method = RequestMethod.POST,
        value = "/test/{groupObj}",
        consumes = { "application/json" }
    )
    @ResponseStatus(HttpStatus.CREATED)
    
    default void _postToTest(
        @com.test.MyAnnotationInPath @Pattern(regexp = "[a-zA-Z]", message="Only letters") @Parameter(name = "groupObj", description = "", required = true, in = ParameterIn.PATH) @PathVariable("groupObj") String groupObj,
        @com.test.MyAnnotationInQuery @NotNull @Pattern(regexp = "[0-9a-fA-F]", message="Only numbers and letters a-f") @Parameter(name = "token", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "token", required = true) String token,
        @com.test.MyAnnotationInHeader @NotNull @Pattern(regexp = "\\d", message="Only numbers") @Parameter(name = "clientId", description = "", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "clientId", required = true) String clientId,
        @Parameter(name = "ObjTest", description = "") @Valid @RequestBody(required = false) ObjTest objTest
    ) {
        postToTest(groupObj, token, clientId, objTest);
    }

@rodrigoma3
Copy link
Contributor Author

@wing328 @borsch Could you evaluate the PR please?

@rodrigoma3
Copy link
Contributor Author

@wing328 This is the continuation of the one you just approved. Could you approve this one too please. #18962

@wing328 wing328 merged commit 21d3cfe into OpenAPITools:master Jun 30, 2024
15 checks passed
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.

[REQ] Support for extra annotations on path parameters
3 participants