Skip to content
GitLab
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
  • !753

[cpp-restsdk] Support multi-line descriptions

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Administrator requested to merge github/fork/zooxco/daniel/escape_descriptions into master Aug 07, 2018
  • Overview 0
  • Commits 3
  • Pipelines 0
  • Changes 39

Created by: Peaches491

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, 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

Using the YAML multi-line string notation will cause cpp-rest-sdk codegen to fail, with the newlines making it into the generated code:

  /job/:
    post:
      summary: "Adds a Job object to the Foo tool."
      operationId: "addJob"
      consumes:
      - "application/json"
      parameters:
      - in: "body"
        name: "fullJobDetails"
        description: |
          "JSON that contains all information needed to create a job for
           FooAPI."
        required: true
        schema:
          $ref: "#/definitions/FullJobDetails"

Yields:

    /// <summary>
    /// \&quot;Updates an ImageAttachment\&quot;·
    /// </summary>
    /// <remarks>
    ///·
    /// </remarks>
    /// <param name="fullJobDetails">\&quot;JSON that contains all information needed to create a job for
           FooAPI.\&quot; </param>
    pplx::task<std::shared_ptr<ImageFrameAttachment>> updateImageWithId(
        utility::string_t imageId,
        std::shared_ptr<ImageFrameAttachment> imageFrameAttachment
    ) override;

The uncommented FooAPI.\&quot; </param>, causes a compilation error.

This PR adds escapeText to all references to the numerous description references across DefaultCodegen.java

Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: github/fork/zooxco/daniel/escape_descriptions