feat!: Remove Notify field out of Device dto and add Properties field into ProvisionWatcher dto #4375
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
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]>
|
Kudos, SonarCloud Quality Gate passed!
|
This was referenced Feb 21, 2023
judehung
added a commit
to judehung/edgex-go
that referenced
this pull request
Feb 21, 2023
Three map[string]any fields are recently added into DTOs:
1. tags field of Device DTO
2. properties field of Device DTO
3. properties field of ProvisionWatcher
The proper way to show map[string]any in swagger is like following:
tags:
tag1:
field1: "field1Value"
field2: "field2Value"
tag2:
field3: "field3Value"
field4: "field4Value"
field5: "field5Value"
However, edgexfoundry#4375 accidentally add extra hyphens like following:
tags:
- tag1:
field1: "field1Value"
field2: "field2Value"
- tag2:
field3: "field3Value"
field4: "field4Value"
field5: "field5Value"
Those hyphens should be removed for proper map[string] representation.
Signed-off-by: Jude Hung <[email protected]>
This was referenced Feb 21, 2023
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]>
1 task
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.
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.
Per edgexfoundry/go-mod-core-contracts#803, the ProvisionWatcher DTO is updated with a new Properties field.
This commit updates following material to reflect such changes:
If your build fails due to your commit message not passing the build checks, please review the guidelines here: https://github.com/edgexfoundry/edgex-go/blob/main/.github/Contributing.md
PR Checklist
Please check if your PR fulfills the following requirements:
BREAKING CHANGE:describing the break)Testing Instructions
New Dependency Instructions (If applicable)