-
Notifications
You must be signed in to change notification settings - Fork 663
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
MG-2053 : Structure API Endpoints Based on Entities #2195
base: main
Are you sure you want to change the base?
Conversation
58e29a0
to
6f1aac9
Compare
8a2578f
to
d1bb489
Compare
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.
Some endpoints have not been updated on the SDK for example
channels/users/userID
channesl/groups/groupID
groups/channels/channelID
users/domains/domainID
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.
For SDK changes add tests to make sure they work
7815468
to
6b9cec8
Compare
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.
Consider updating the sdk.go
with updated documentation for the new sdk functions. Also you can regenerate the mocks after making changes to the interface.
It is already up to date @1998-felix |
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.
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.
Regarding the conversation that was held change this to use query parameters for example
/channels/things/thingID
to /channels?thing=<id>
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.
At present we have /things/thingID/channels
to list channels
After this PR #2195 it will be like
/channels/things/thingID
to list channels
which doesn't looks good and ideal
I have discussed this with @dborovcanin , He proposed like this /channels?thing=<id>
I agree with his proposal,
Already we are having /channels
which is used for listing all channels,
/channels?thing=<id>
can be used to listing channels of particular thing id.
/channels?user=<id>
can be used to listing channels of particular user id.
and so on.
f753a58
to
21dc1f6
Compare
50a7944
to
4f9abae
Compare
Signed-off-by: WashingtonKK <washingtonkigan@gmail.com> update api docs Signed-off-by: WashingtonKK <washingtonkigan@gmail.com> fix: ci Signed-off-by: WashingtonKK <washingtonkigan@gmail.com> refactor tests Signed-off-by: WashingtonKK <washingtonkigan@gmail.com> update sdk Signed-off-by: WashingtonKK <washingtonkigan@gmail.com> update sdk Signed-off-by: WashingtonKK <washingtonkigan@gmail.com> refactor: api docs and sdk Signed-off-by: WashingtonKK <washingtonkigan@gmail.com> fix: api docs' Signed-off-by: WashingtonKK <washingtonkigan@gmail.com> update sdk and docs Signed-off-by: WashingtonKK <washingtonkigan@gmail.com> update groups sdk and docs Signed-off-by: WashingtonKK <washingtonkigan@gmail.com> feeat(groups): add groups sdk tests Signed-off-by: WashingtonKK <washingtonkigan@gmail.com> feat(sdk): tests Signed-off-by: WashingtonKK <washingtonkigan@gmail.com> fix: sdk tests Signed-off-by: WashingtonKK <washingtonkigan@gmail.com> feat(users): add api tests Signed-off-by: WashingtonKK <washingtonkigan@gmail.com> fix(api tests): add missing tests Signed-off-by: WashingtonKK <washingtonkigan@gmail.com> fix: users api tests Signed-off-by: WashingtonKK <washingtonkigan@gmail.com> fix: ci Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>
Signed-off-by: WashingtonKK <washingtonkigan@gmail.com> fix domain endpoint tests Signed-off-by: WashingtonKK <washingtonkigan@gmail.com> fix tests Signed-off-by: WashingtonKK <washingtonkigan@gmail.com> update sdk Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>
Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>
Signed-off-by: WashingtonKK <washingtonkigan@gmail.com> fix: ci Signed-off-by: WashingtonKK <washingtonkigan@gmail.com> tmp Signed-off-by: WashingtonKK <washingtonkigan@gmail.com> refactor decode Signed-off-by: WashingtonKK <washingtonkigan@gmail.com> ci Signed-off-by: WashingtonKK <washingtonkigan@gmail.com> update docs Signed-off-by: WashingtonKK <washingtonkigan@gmail.com> refactor endpoint Signed-off-by: WashingtonKK <washingtonkigan@gmail.com> fix missing parameter Signed-off-by: WashingtonKK <washingtonkigan@gmail.com> fix docs Signed-off-by: WashingtonKK <washingtonkigan@gmail.com> update docs Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>
Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>
What type of PR is this?
This is a refactor because it changes the naming and structuring of API endpoints.
What does this do?
This restructures API endpoints so that they are named based on entities such as groups, channels, users, things etc.
Which issue(s) does this PR fix/relate to?
Have you included tests for your changes?
No, I have not included tests.
Did you document any new/modified feature?
Yes, I have updated the documentation for the new feature.
Notes