Process swagger file cross reference when generating API review #7438
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
praveenkuttappan
added
APIView
Central-EngSys
|
/azp run tools - swaggerapiparser |
|
No pipelines are associated with this pull request. |
|
/azp run tools - SwaggerApiParser |
|
Azure Pipelines successfully started running 1 pipeline(s). |
maririos
approved these changes
Dec 12, 2023
|
Are there any test we can add for this? |
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.
Swagger file refers to a definition in another swagger file and sometimes this definition in second swagger file might have a schema reference to another definition within same file and this reference will be a local reference. API review parser incorrectly searches for this local reference in first swagger file instead of second file where it's defined.
PR has the fix to correctly refer the swagger file based on the parent reference if current reference path is local.
For e.g. data.json has a reference to 202response definition which is in common.json and 202response has a reference to longrunningoperationresult schema using local reference
#LongRunningOperationResultand it's defined in common.json. We need to make sure parser refers common.json when processing#LongRunningOperationResultschema instead of data.json.