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

Show validation errors #8212

Merged

Conversation

fredden
Copy link
Contributor

@fredden fredden commented Sep 30, 2022

Description

When using the "try it out" feature, the request is validated locally before being sent to the server. If the request fails validation, nothing happens. (The request is not sent.)

This pull request adds display of the validation errors so that the user can see why the request was not sent, and has an opportunity to resolve the problem(s) identified.

Motivation and Context

This fixes #6295

How Has This Been Tested?

I have used the test case given in #6295.

Screenshots

Screenshot_2022-09-30_16-55-16

Checklist

My PR contains...

  • No code changes (src/ is unmodified: changes to documentation, CI, metadata, etc.)
  • Dependency changes (any modification to dependencies in package.json)
  • Bug fixes (non-breaking change which fixes an issue)
  • Improvements (misc. changes to existing features)
  • Features (non-breaking change which adds functionality)

My changes...

  • are breaking changes to a public API (config options, System API, major UI change, etc).
  • are breaking changes to a private API (Redux, component props, utility functions, etc.).
  • are breaking changes to a developer API (npm script behavior changes, new dev system dependencies, etc).
  • are not breaking changes.

Documentation

  • My changes do not require a change to the project documentation.
  • My changes require a change to the project documentation.
  • If yes to above: I have updated the documentation accordingly.

Automated tests

  • My changes can not or do not need to be tested.
  • My changes can and should be tested by unit and/or integration tests.
  • If yes to above: I have added tests to cover my changes.
  • If yes to above: I have taken care to cover edge cases in my tests.
  • All new and existing tests passed.

@fredden fredden force-pushed the try-it-out/display-validation-errors branch from 659e785 to 0d5677c Compare September 30, 2022 17:46
@fredden fredden marked this pull request as ready for review September 30, 2022 17:47
@tim-lai
Copy link
Contributor

tim-lai commented Oct 13, 2022

@fredden Thanks for the PR! Looks good to me. Although just need to fix the lint errors in the test before approval/merge. Refer to CI check or below:

/home/runner/work/swagger-ui/swagger-ui/test/e2e-cypress/tests/features/multiple-examples-core.js
Error:   619:17  error  Strings must use doublequote  quotes

@tim-lai tim-lai self-assigned this Oct 13, 2022
@fredden fredden force-pushed the try-it-out/display-validation-errors branch from 0d5677c to bb281f1 Compare October 14, 2022 08:08
@fredden
Copy link
Contributor Author

fredden commented Oct 14, 2022

Thanks @tim-lai. I've made that change and rebased the pull request onto the latest changes in master. Please can you check again?

@tim-lai tim-lai merged commit 130a1be into swagger-api:master Oct 14, 2022
@tim-lai
Copy link
Contributor

tim-lai commented Oct 14, 2022

Thanks @tim-lai. I've made that change and rebased the pull request onto the latest changes in master. Please can you check again?

Done. PR merged. Thanks for the contribution!

@fredden fredden deleted the try-it-out/display-validation-errors branch October 15, 2022 10:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Execute button is not working with 'malformed' JSON body
2 participants