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 unescaped description in requestBody #857

Conversation

matthesrieke
Copy link
Contributor

@matthesrieke matthesrieke commented Aug 21, 2018

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh and ./bin/security/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\.
  • Filed the PR against the correct branch: master, 3.3.x, 4.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

This is a very small fix and re-uses existing functionality. It solves a glitch in OpenAPI 3 generation where the description of a requestBody of a POST operation was not escaped and caused code generators to have line breaks where no line breaks are allowed. Example:

    post:
      description: |
        Creates a new Job in the
        repository
      operationId: createJob
      requestBody:
        description: |
          Job to add to the 
          repository

was resulting in (lines 9-11):

    @ApiOperation(value = "", nickname = "createJob", notes = "Creates a new Job in the repository ", response = Job.class, tags={  })
    @ApiResponses(value = { 
        @ApiResponse(code = 201, message = "job response ", response = Job.class),
        @ApiResponse(code = 500, message = "unexpected error ", response = Error.class) })
    @RequestMapping(value = "/jobs",
        produces = { "application/json" }, 
        consumes = { "application/json" },
        method = RequestMethod.POST)
    default ResponseEntity<Job> createJob(@ApiParam(value = "Job to add to the
repository
",required=true)  @Valid @RequestBody Job job
) {

The fix is to re-use the existing escapeText method in DefaultCodegen.

@wing328
Copy link
Member

wing328 commented Aug 21, 2018

@matthesrieke thanks. The fix looks good to me. I'll merge it when all the CI tests pass.

I'll also review to see if other description fields have the similar issue.

@matthesrieke
Copy link
Contributor Author

you are very welcome, the least I could do to support a great project :-)

@wing328 wing328 changed the title fix unescaped description in requestBody Fix unescaped description in requestBody Aug 21, 2018
@wing328 wing328 merged commit 39763a8 into OpenAPITools:master Aug 21, 2018
@wing328
Copy link
Member

wing328 commented Aug 21, 2018

@matthesrieke thanks for the PR (merged) and joining the awesome team of contributors to move the project forward.

@wing328
Copy link
Member

wing328 commented Aug 21, 2018

As a follow-up, I've filed #866 to escape other descriptions in DefaultCodegen

@wing328
Copy link
Member

wing328 commented Aug 22, 2018

@matthesrieke thanks for the fix, which is included in the v3.2.2 stable release: https://twitter.com/oas_generator/status/1032252335131512832

A-Joshi pushed a commit to ihsmarkitoss/openapi-generator that referenced this pull request Feb 27, 2019
Fix unescaped description in requestBody
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants