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

feat!: Remove Notify out of Device DTO/Model #807

Merged
merged 1 commit into from
Feb 21, 2023

Conversation

judehung
Copy link
Member

@judehung judehung commented Feb 20, 2023

BREAKING CHANGE: remove Notify out of Device DTO/Model

The current Device model/DTO contains a boolean filed notify. When notify is set to true, the device service managing the device will receive a notification. Since core-metadata will publish system event message when device is created or updated, this notify is no longer needed and should be removed.

fixes #805

If your build fails due to your commit message not passing the build checks, please review the guidelines here: https://github.com/edgexfoundry/go-mod-core-contracts/blob/main/.github/Contributing.md

PR Checklist

Please check if your PR fulfills the following requirements:

  • I am not introducing a breaking change (if you are, flag in conventional commit message with BREAKING CHANGE: describing the break)
  • I am not introducing a new dependency (add notes below if you are)
  • I have added unit tests for the new feature or bug fix (if not, why?)
  • I have fully tested (add details below) this the new feature or bug fix (if not, why?)
  • I have opened a PR for the related docs change (if not, why?)

Testing Instructions

New Dependency Instructions (If applicable)

BREAKING CHANGE: remove Notify out of Device DTO/Model

The current Device model/DTO contains a boolean filed `notify`.  When notify is set to true, the device service managing the device will receive a notification.  Since core-metadata will publish system event message when device is created or updated, this notify is no longer needed and should be removed.

fixes edgexfoundry#805

Signed-off-by: Jude Hung <[email protected]>
@codecov-commenter
Copy link

Codecov Report

Merging #807 (cb18066) into main (1bb5704) will increase coverage by 0.03%.
The diff coverage is n/a.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@            Coverage Diff             @@
##             main     #807      +/-   ##
==========================================
+ Coverage   64.46%   64.49%   +0.03%     
==========================================
  Files          80       80              
  Lines        3079     3076       -3     
==========================================
- Hits         1985     1984       -1     
+ Misses        905      904       -1     
+ Partials      189      188       -1     
Impacted Files Coverage Δ
dtos/device.go 35.29% <ø> (-1.25%) ⬇️
dtos/requests/device.go 87.09% <ø> (+2.72%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Copy link
Member

@cloudxxx8 cloudxxx8 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@judehung judehung marked this pull request as ready for review February 20, 2023 07:53
@cloudxxx8 cloudxxx8 merged commit 0fdee9e into edgexfoundry:main Feb 21, 2023
judehung added a commit to judehung/edgex-go that referenced this pull request Feb 21, 2023
field into ProvisionWatcher dto

BREAKING CHANGE: Remove Notify field out of Device model/dto

Per edgexfoundry/go-mod-core-contracts#807, the boolean field notify of Device DTO is removed as device creation notification is handled by system event message now.  This commit updates following material to reflect such changes:
1. update go.mod/go.sum to use v3.0.0-dev.20
2. update swagger file correspondingly (remove notify field out of Device dto and add properties field into ProvisionWatcher dto)
3. update unit test correspondingly

Signed-off-by: Jude Hung <[email protected]>
judehung added a commit to judehung/edgex-docs that referenced this pull request Feb 22, 2023
Per edgexfoundry/edgex-go#4375 and
edgexfoundry/go-mod-core-contracts#807, the notify field of Device DTO is removed, so that documentation should be updated to remove the notify field as well.

Signed-off-by: Jude Hung <[email protected]>
judehung added a commit to judehung/edgex-docs that referenced this pull request Feb 22, 2023
Per edgexfoundry/edgex-go#4375 and
edgexfoundry/go-mod-core-contracts#807,
the notify field of Device DTO is removed, so that documentation should be
updated to remove the notify field as well.

Signed-off-by: Jude Hung <[email protected]>
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.

[EdgeX 3.0] Remove notify field out of Device model/DTO
3 participants