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

[Wsdl] Adding cli-option for generating different versions of WSDL-files regarding Media type versioning (content negotiation)

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Administrator requested to merge github/fork/adessoDpd/wsdl-versioning into master Apr 22, 2022
  • Overview 0
  • Commits 5
  • Pipelines 0
  • Changes 43

Created by: adessoDpd

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.
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Description of the PR This PR adds the cli option "contentTypeVersion" to generate different versions of WSDL-files regarding Media type versioning (content negotiation).

Example:

/analysis/location:
    post:
      summary: "Make location analysis"
      requestBody:
        description: "Input parameter for analysis"
        content:
          application/vnd.company.location.api.v1+json:
            schema:
              $ref: "#/components/schemas/AnalysisParameterV1"
          application/vnd.company.location.api.v2+json:
            schema:
              $ref: "#/components/schemas/AnalysisParameterV2"
        required: true
      responses:
        200:
          description: "The analysis for the location could be successfully carried out."
          content:
            application/vnd.company.location.api.v1+json:
              schema:
                $ref: "#/components/schemas/LocationAnalysisV1"  
            application/vnd.company.location.api.v2+json:
              schema:
                $ref: "#/components/schemas/LocationAnalysisV2"

Before: The request- and response-data of the first content-type ( application/vnd.company.location.api.v1+json) were always used since v1 was specified in the first place.

Now in case of Media type versioning the available content-data of requests and responses are used. By for example specifying the mediatype "application/vnd.company.location.api.v2" the correct models/datatypes of the specified version are used for the requests and responses. Additionally models are filtered out from the WSDL-file which are used by other versions. In this case the models "AnalysisParameterV1" and "LocationAnalysisV1" won't appear in the generated WSDL-file since they are used by "application/vnd.company.location.api.v1".

Furthermore one small change/ cli option was added (useSpecifiedOperationId). It provides the option to use the operationIds specified inside the openapi spec, instead of the ones which are generated by the WSDL-generator by default.

Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: github/fork/adessoDpd/wsdl-versioning