Changed default description to empty string instead of null #438
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
Codecov Report
@@ Coverage Diff @@
## main #438 +/- ##
============================================
- Coverage 77.70% 77.57% -0.14%
+ Complexity 4111 4109 -2
============================================
Files 296 296
Lines 17657 17657
Branches 1879 1879
============================================
- Hits 13720 13697 -23
- Misses 3032 3058 +26
+ Partials 905 902 -3
Flags with carried forward coverage won't be shown. Click here to find out more.
|
ohltyler
previously approved these changes
Mar 15, 2022
There was a problem hiding this comment.
@amitgalitz thanks for the quick work and owning this issue!
ylwu-amzn
previously approved these changes
Mar 15, 2022
Signed-off-by: Amit Galitzky <amgalitz@amazon.com>
amitgalitz
force-pushed
the
fix-description-bug
branch
from
b09bbcf
to
19cafca
Compare
|
rebased with main @ohltyler @ylwu-amzn |
ohltyler
approved these changes
Mar 15, 2022
ylwu-amzn
approved these changes
Mar 15, 2022
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Mar 22, 2022
Signed-off-by: Amit Galitzky <amgalitz@amazon.com> (cherry picked from commit 124a269)
amitgalitz
added a commit
that referenced
this pull request
Mar 22, 2022
Signed-off-by: Amit Galitzky <amgalitz@amazon.com> (cherry picked from commit 124a269)
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.
Signed-off-by: Amit Galitzky amgalitz@amazon.com
Description
Changed the default description field to be set to an empty string instead of a null field. This means that description should also be changed from a
requiredfield as listed in documentation to anoptionalfield since if detector description is missing then it will be filled as an empty string.Currently if there is a missing description field, the backend still creates the detector even though it is listed as
requiredwhich causes issues on the frontend which tries to parse a null a value unsuccessfully when getting the relevant detector.Other option is to throw an exception if description is missing and hence enforce the
requireddescription which we don't enforce on the backend today and we also let users know it is optional on the frontend, where we just have it as empty if not filled out. For this reason, it makes more sense to just keep it consistent as an 'optional' field from UX point of view.Reproduced the bug stated in the issue before change was made and tested that bug doesn't occur after this change
Issues Resolved
resolves #437
Check List
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.