-
Notifications
You must be signed in to change notification settings - Fork 126
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!: replace REST device callbacks with System Events #1276
Conversation
Codecov Report
@@ Coverage Diff @@
## main #1276 +/- ##
==========================================
+ Coverage 50.26% 50.89% +0.62%
==========================================
Files 27 27
Lines 2441 2405 -36
==========================================
- Hits 1227 1224 -3
+ Misses 1108 1075 -33
Partials 106 106
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
While System Events are the better way (compared to REST callbacks), and the way I'd want to use, did we decide that they were to be the only way for everybody? |
Yes, no need for both options as this is internal between Core Metadata and the Device Services. All handled in the SDKs. |
@@ -85,6 +85,7 @@ PublishTopicPrefix = "edgex/events/device" # /<device-profile-name>/<device-name | |||
[MessageQueue.Topics] | |||
CommandRequestTopic = "edgex/device/command/request/device-simple/#" # subscribing for inbound command requests | |||
CommandResponseTopicPrefix = "edgex/device/command/response" # publishing outbound command responses; <device-service>/<device-name>/<command-name>/<method> will be added to this publish topic prefix | |||
SystemEventTopic = "edgex/system-events/#" |
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.
Do we want make this more specific to core-metadata
device system events and ones only for this service?
/<source>/<type>/<action>/<owner>/<profile> will be added to this Publish Topic
SystemEventTopic = "edgex/system-events/#" | |
SystemEventTopic = "edgex/system-events/core-metadata/device/#/device-simple/#" |
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.
LGTM - @cloudxxx8 Note there needs to be specific PRs for each Device service to consume this since their configuration needs to be updated. i.e. can't just merge depend-a-bot PRs
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.
LGTM
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.
please remove the API from the Swagger file as well
do we need to create a |
yes, you are right. please create a openapi/v3 directory. |
BREAKING CHANGE: the following device callback REST endpoints are removed: - POST /callback/device - PUT /callback/device - DELETE /callback/device/name/{name} closes edgexfoundry#1259 Signed-off-by: Chris Hung <chris@iotechsys.com>
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.
LGTM
BREAKING CHANGE:
the following device callback REST endpoints are removed:
closes #1259
Signed-off-by: Chris Hung chris@iotechsys.com
If your build fails due to your commit message not passing the build checks, please review the guidelines here: https://github.com/edgexfoundry/device-sdk-go/blob/main/.github/Contributing.md
PR Checklist
Please check if your PR fulfills the following requirements:
BREAKING CHANGE:
describing the break)Testing Instructions
device-simple
from this branch withWRITABLE_LOGLEVEL: DEBUG
New Dependency Instructions (If applicable)