Feature 1436 load api defintion from url #3059
Open
Conversation
This file contains 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
Member
winzj
commented
Apr 4, 2024
winzj
commented
- closes webscan config support loading api definitions from URL #1436
de-jcup
approved these changes
May 24, 2024
| @@ -234,6 +235,18 @@ public ApiResponse importOpenApiFile(String openApiFile, String url, String cont | |||
| return clientApi.openapi.importFile(openApiFile, url, contextId); | |||
| } | |||
|
|
|||
| /** | |||
| * | |||
There was a problem hiding this comment.
Please: Either remove the javadoc part or write a text and describe the parameters.
| @@ -48,4 +52,20 @@ void json_attribute_use_is_handled_correctly_by_to_json() { | |||
| assertEquals(expected, json); | |||
| } | |||
|
|
|||
| @Test | |||
| void api_definition_url_is_handled_correctly() throws MalformedURLException { | |||
| /* test */ | ||
| String expected = "{\"apiDefinitionUrl\":\"https://example.com/api/v1/swagger/\",\"use\":[]}"; | ||
| assertEquals(expected, json); | ||
| assertEquals(config.getApiDefinitionUrl(), apiConfig.getApiDefinitionUrl()); |
There was a problem hiding this comment.
What about a renaming here ?
Suggested change
| assertEquals(config.getApiDefinitionUrl(), apiConfig.getApiDefinitionUrl()); | |
| assertEquals(originConfig.getApiDefinitionUrl(), loadedConfig.getApiDefinitionUrl()); |
| @@ -12,7 +12,8 @@ | |||
| "url" : "https://productfailure.demo.example.org", | |||
| "api" : { | |||
| "type" : "openApi", //<2> | |||
| "use" : [ "open-api-file-reference" ] //<3> | |||
| "use" : [ "open-api-file-reference" ], //<3> | |||
There was a problem hiding this comment.
Have we ensured that a file without "apiDefintionUrl" inside is also loaded as well - i am not sure here.
| "url" : "https://localhost:8443", | ||
| "api" : { | ||
| "type" : "openApi", | ||
| "apiDefinitionUrl" : "https://example.com/api/v1/swagger/?format=openapi", |
There was a problem hiding this comment.
Is it correct that we allow "use" + "apiDefinitionUrl" at the same time?
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.