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

fix: Improve error handling in case of failure when retrieving API doc #3932

Merged
merged 7 commits into from
Dec 16, 2024

Conversation

taban03
Copy link
Contributor

@taban03 taban03 commented Dec 16, 2024

Description

Propagate exception message to the UI in case of failure of retrieving API doc either from the service or from the cache. It covers the following cases:

  1. The Swagger definition was retrieved but was not a valid JSON document. + message from the parser
  2. The Swagger definition was retrieved but it was not a valid Swagger JSON document according to the schema + message from parser
  3. The Swagger URL is not valid

Linked to #2315

Type of change

  • fix: Bug fix (non-breaking change which fixes an issue)

Checklist:

  • My code follows the style guidelines of this project
  • PR title conforms to commit message guideline ## Commit Message Structure Guideline
  • I have commented my code, particularly in hard-to-understand areas. In JS I did provide JSDoc
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • The java tests in the area I was working on leverage @nested annotations
  • Any dependent changes have been merged and published in downstream modules

Signed-off-by: Andrea Tabone <[email protected]>
Signed-off-by: Andrea Tabone <[email protected]>
@taban03 taban03 changed the title fix: Improve error handling in case of failing when retrieving API doc fix: Improve error handling in case of failure when retrieving API doc Dec 16, 2024
Signed-off-by: Andrea Tabone <[email protected]>
Signed-off-by: Andrea Tabone <[email protected]>
Signed-off-by: Andrea Tabone <[email protected]>
@taban03 taban03 merged commit 3fb0d59 into v3.x.x Dec 16, 2024
28 checks passed
@taban03 taban03 deleted the reboot/GH2315/improve_swagger_errorhandling branch December 16, 2024 13:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Development

Successfully merging this pull request may close these issues.

2 participants