Skip to content
GitLab

[JAXRS-spec] Add option useSwaggerAnnotations (for MicroProfile-OpenAPI)

Merged Administrator requested to merge github/fork/michbeck100/filter_swagger_annotations into master

Created by: michbeck100

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

The Microprofile OpenAPI specification allows to have just a static openapi.yaml file in the application module’s root META-INF folder (see here). So this PR adds an additional property "useSwaggerAnnotations" that doesn't generate the Swagger annotations if set to false (default value is true for backward compatibility).

This way you can easily generate code that conforms to contract first and is compliant with the microprofile openapi specification