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
  • !3202

[openapi-yaml] Prerequisities for Swagger 2 template.

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Administrator requested to merge github/fork/MichalFoksa/feature/preparation-for-swagger2-template into master Jun 22, 2019
  • Overview 0
  • Commits 1
  • Pipelines 0
  • Changes 1

Created by: MichalFoksa

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, ./bin/openapi3/{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\. If contributing template-only or documentation-only changes which will change sample output, be sure to build the project first.
  • Filed the PR against the correct branch: master, 4.1.x, 5.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

I am looking for a way to convert from Openapi 3 to Swagger 2 specification. I think openapi-yaml generator with custom template is a good starting point.

In order to start, I needed to modify current generator to:

  1. Group operations by resourcePath (they are grouped by tag currently) so that operations with same path are rendered one after the other: Example:
      /pet:
        post:
          .....
        put:
          .....
      /pet/findByStatus:
        get:
        .....

And not (it might happen when grouped by a tag):

      /pet:
        post:
        .....
      /pet/findByStatus:
        get:
        .....
      /pet: 
        put:
        .....
  1. Created a Mustache lambda OnChangeLambda to return fragment only when current fragment is different than previous fragment. It will be used to render endpoint path only for a first operation in group.

  2. Registered lambdas like lowercase, onchage (above one), uppercase, etc.

Later I am hoping to submit Swagger 2 template a new library.

Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: github/fork/MichalFoksa/feature/preparation-for-swagger2-template