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

SWG-7517 updating the resolving options of swagger-parser-v3 #12140

Merged

Conversation

MiloszTarka
Copy link
Member

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: 3.0.0 branch for changes related to OpenAPI spec 3.0. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

This PR adds possibility to utilize allow and block lists provided through environmental variables when using OpenAPIV3Parser (swagger-parser-v3) in order to safely resolve definitions.

To see the detailed explanation of this functionality please see the following pull requests:
swagger-api/swagger-parser#1910
swagger-api/swagger-parser#1911

Sorry, something went wrong.

@@ -674,6 +678,21 @@ private ParseOptions buildParseOptions() {
options.setFlatten(true);
options.setFlattenComposedSchemas(flattenInlineSchema);
options.setSkipMatches(this.skipInlineModelMatches);

if (Objects.equals(System.getenv("SAFELY_RESOLVE_URL"), "true")) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, let's keep consistency using same logic

Copy link
Member Author

@MiloszTarka MiloszTarka May 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the reviews! :) Sorry about the delay, I was unavailable last couple of days.

@MiloszTarka MiloszTarka merged commit ef05c09 into 3.0.0 May 12, 2023
@MiloszTarka MiloszTarka deleted the SWG-7517-updating-the-resolving-options-of-swagger-parser-v3 branch May 12, 2023 12:47
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.

None yet

3 participants