[JaxRS-Spec] add openApiSpecFileLocation parameter#3344
Merged
wing328 merged 2 commits intoOpenAPITools:masterfrom Jul 14, 2019
Merged
[JaxRS-Spec] add openApiSpecFileLocation parameter#3344wing328 merged 2 commits intoOpenAPITools:masterfrom
wing328 merged 2 commits intoOpenAPITools:masterfrom
Conversation
ef85c04 to
516163b
Compare
wing328
reviewed
Jul 12, 2019
| "openapi.yaml") | ||
| ); | ||
| if(StringUtils.isNotEmpty(openApiSpecFileLocation)) { | ||
| int index = openApiSpecFileLocation.lastIndexOf('/'); |
Member
There was a problem hiding this comment.
@jmini shall we use File.separator instead of / so that the option also works in Windows?
Member
Author
There was a problem hiding this comment.
I think even on windows the users will use openApiSpecFileLocation = some/location/openapi.yaml as input.
(think of a maven/gradle build that works on both windows and linux/macos)
That will result of creating a file at output-folder\some\location\openapi.yaml.
As you can see I have a test:
Line 240 the variable is set to
"src/main/resources/META-INF/openapi.yaml"Line 255 there is a check that the file is created.
This is already working on windows (appveyor CI is green)
Member
There was a problem hiding this comment.
I think even on windows the users will use openApiSpecFileLocation = some/location/openapi.yaml as input.
👌 Let's see.
wing328
approved these changes
Jul 14, 2019
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR checklist
./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.shif 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.master,4.1.x,5.0.x. Default:master.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
openApiSpecFileLocationto be able to specify where the generated spec should be generated.src/main/openapi/openapi.yaml(no change for existing users)src/main/resources/META-INF/openapi.yamlto be conform with the MP-OpenAPI specnullor empty string""Fixes #809