-
Notifications
You must be signed in to change notification settings - Fork 0
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
Add the IOTICS circle services #40
Conversation
proto/iotics/api/circle.proto
Outdated
// Services only affect local resources. | ||
service CircleAPI { | ||
|
||
// UpsertCircle creates or update a circle with its metadata. |
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.
Creates or updates
(same for twin)
// DeleteCircle deletes a circle. | ||
rpc DeleteCircle(DeleteCircleRequest) returns (DeleteCircleResponse) {} | ||
|
||
// Describes a circle. |
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.
(pedantic) Based on how the other ones are written, should this and the below one say e.g.:
"DescribeCircle describes a circle"?
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.
Before this was mandatory due to the previous linter we were using. But this information is redundant and annoying to maintain.
} | ||
|
||
|
||
message UpsertCircleRequest { |
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.
(unimportant) some of the other definitions also have a docstring for each message type. (So I added them for e.g. the ACL PR). But I also appreciate that they are self-explanatory.
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.
Yes same.
We prefer to go with consistency over "better" approach for the logic but we can stop adding redundant comments
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 ✔️
V. minor docstring observations only.
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
39ce3a4
to
b5a08d4
Compare
Thanks for the reviews |
Add IOTICS circle services:
The remaining one will be part of another PR