-
Notifications
You must be signed in to change notification settings - Fork 73
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
Changed default description to empty string instead of null #438
Changed default description to empty string instead of null #438
Conversation
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.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@amitgalitz thanks for the quick work and owning this issue!
Signed-off-by: Amit Galitzky <[email protected]>
b09bbcf
to
19cafca
Compare
rebased with main @ohltyler @ylwu-amzn |
Signed-off-by: Amit Galitzky <[email protected]> (cherry picked from commit 124a269)
Signed-off-by: Amit Galitzky <[email protected]> (cherry picked from commit 124a269)
Signed-off-by: Amit Galitzky [email protected]
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
required
field as listed in documentation to anoptional
field 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
required
which 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
required
description 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.