Created by: jmini
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. Java: @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04)
Description of the PR
Currently the OpenAPI Spec is generated to src/main/openapi/openapi.yaml
. This is not conform with the Eclipse MicroProfile OpenAPI which is the spec that defines how OpenAPI should be used on top of JAX-RS.
This PR introduces a new parameter openApiSpecFileLocation
to be able to specify where the generated spec should be generated.
- Default value:
src/main/openapi/openapi.yaml
(no change for existing users) - Possible value
src/main/resources/META-INF/openapi.yaml
to be conform with the MP-OpenAPI spec - In order to not generate the spec, the value can be set to
null
or empty string""
Fixes #809 (closed)