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
./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.