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: remove clearValidation from onTryoutClick (#5070) #5955

Conversation

tim-lai
Copy link
Contributor

@tim-lai tim-lai commented Apr 8, 2020

Description

Remove clearValidation function from onClick of Try It Out. As a result, the red error field will remain red.

In addition, the input box will now also re-bounce on subsequent onClick of "Execute"

Fixes #5070

Motivation and Context

From #5070, Clicking on Try It Out button also calls a function that clears the validation errors that might be present. It can be confusing to the user that the error appears to have gone away when the red validation fields disappears. However, the error is actually still present, and Execute will not fire off an actual request (this part is ok and expected)

How Has This Been Tested?

new cypress test included in this PR

Screenshots (if appropriate):

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.

@tim-lai tim-lai requested a review from shockey April 8, 2020 21:52
@tim-lai tim-lai force-pushed the bug/5070-remove-clear-validation-try-it-out branch from 0970ec8 to 9234f3e Compare April 10, 2020 16:12
@tim-lai tim-lai force-pushed the bug/5070-remove-clear-validation-try-it-out branch from 9234f3e to 9dfb308 Compare May 6, 2020 21:00
@tim-lai tim-lai merged commit 4542806 into swagger-api:master May 6, 2020
@tim-lai tim-lai changed the title bug: remove clearValidation from onTryoutClick (#5070) fix: remove clearValidation from onTryoutClick (#5070) May 6, 2020
@tim-lai tim-lai deleted the bug/5070-remove-clear-validation-try-it-out branch May 15, 2020 16:16
Pentusha added a commit to Pentusha/swagger-ui that referenced this pull request May 27, 2020
* 'master' of github.com:swagger-api/swagger-ui: (37 commits)
  release: v3.25.4
  chore(package): bump swagger-client to 3.10.4 version
  fix: entries as property name (swagger-api#6025)
  release: v3.25.3
  housekeeping: update release-it config (swagger-api#6009)
  housekeeping: bump swagger-client version with package-lock (swagger-api#6008)
  housekeeping: update dev-e2e-cypress-open script name (swagger-api#6005)
  fix: jsonSchemaComponent file/files (swagger-api#5997) (swagger-api#6000)
  fix: curl array support within multipart/form-data (swagger-api#3838) (swagger-api#5999)
  release: v3.25.2
  bug: remove clearValidation from onTryoutClick (swagger-api#5955)
  ft: JsonSchema components are now ImmutableJS compliant (swagger-api#5952)
  release: v3.25.1
  housekeeping: revert @release-it/conventional-changelog version (swagger-api#5976)
  housekeeping: add missing conventional-changelog devDeps (swagger-api#5975)
  docs: update plugin api component for failSilently (swagger-api#5953)
  housekeeping: `npm audit fix` (swagger-api#5948)
  housekeeping: prevent log warning for missing getComponent in production
  fix(docker-image): send relative HTTP 301s from within container (swagger-api#5409)
  support for supportedSubmitMethods property in react component (swagger-api#5376)
  ...
mattyb678 pushed a commit to mattyb678/swagger-ui that referenced this pull request Jun 24, 2020
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.

Required field not highlighted on click of Execute button (second time)
1 participant