Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove dependency scan for inputSpec (actually not required) #19084

Merged
merged 3 commits into from
Jul 9, 2024

Conversation

parenko
Copy link
Contributor

@parenko parenko commented Jul 5, 2024

This PR fixes #19073.
The dependency scan introduced with #18576 is actually not required. (And I am i am sorry for the inconvenience.)
Resolution for inputSpec works with correct classpath setup or absolute file reference.
Also it is still possible to provide an JAR inputSpec. (Swagger only supports collapsed OpenApiSpec without external refs currently).

To reproduce #19073 we need a dependency which contains an OpenApiSpec with external refs and which are not in current class path. First commit in this PR does this.

CC @wing328

  • 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/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    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*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.6.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@parenko parenko force-pushed the issue-19073 branch 5 times, most recently from 5a2586f to 1ab3950 Compare July 8, 2024 20:30
@parenko parenko changed the title test external-ref Remove dependency scan for inputSpec (not required) Jul 8, 2024
@parenko parenko force-pushed the issue-19073 branch 2 times, most recently from 7e4b286 to c8fb37a Compare July 8, 2024 21:43
added test with resource on classpath with external-ref.

Test with profile 'resource' was wrong as it took JAR into account, but there was no 'petstore.yaml' on classpath.
It is still possible to provide JARs as inputSpec, however the user has to provide it by hand.

Providing dependencies in plugin section still allows correct inputSpec resolution on classpath.
@parenko parenko closed this Jul 8, 2024
@parenko parenko reopened this Jul 8, 2024
@parenko parenko changed the title Remove dependency scan for inputSpec (not required) Remove dependency scan for inputSpec (actually not required) Jul 9, 2024
@parenko parenko marked this pull request as ready for review July 9, 2024 04:00
@parenko parenko requested a review from jimschubert as a code owner July 9, 2024 04:00
@wing328
Copy link
Member

wing328 commented Jul 9, 2024

thanks for the fix

@wing328 wing328 merged commit 5612852 into OpenAPITools:master Jul 9, 2024
16 checks passed
@wing328 wing328 added this to the 7.8.0 milestone Jul 9, 2024
@parenko parenko deleted the issue-19073 branch July 12, 2024 10:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG][MAVEN] Classpath $ref to external file are not resolved correctly
2 participants