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

MF-1761 - Improve path parameters naming #1762

Merged
merged 17 commits into from
Apr 20, 2023
Merged

Conversation

ianmuchyri
Copy link
Contributor

What does this do?

Improve path parameters naming

Which issue(s) does this PR fix/relate to?

Resolves #1761

List any changes that modify/break current functionality

None

Have you included tests for your changes?

No

Did you document any new/modified functionality?

No

Notes

Copy link
Member

@rodneyosodo rodneyosodo left a comment

Choose a reason for hiding this comment

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

Also change:

  • bootstrap/api/transport.go
  • twins/api/http/transport.go

@codecov-commenter
Copy link

codecov-commenter commented Apr 11, 2023

Codecov Report

Merging #1762 (fb75f32) into master (23bc094) will increase coverage by 0.02%.
The diff coverage is 91.66%.

📣 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             @@
##           master    #1762      +/-   ##
==========================================
+ Coverage   70.50%   70.53%   +0.02%     
==========================================
  Files         146      146              
  Lines       11482    11514      +32     
==========================================
+ Hits         8095     8121      +26     
- Misses       2745     2748       +3     
- Partials      642      645       +3     
Impacted Files Coverage Δ
users/api/transport.go 68.51% <71.42%> (ø)
things/api/things/http/transport.go 85.79% <88.70%> (-0.43%) ⬇️
auth/api/http/groups/transport.go 45.79% <100.00%> (ø)
auth/api/http/keys/transport.go 86.88% <100.00%> (ø)
bootstrap/api/transport.go 94.47% <100.00%> (ø)
consumers/notifiers/api/transport.go 91.01% <100.00%> (ø)
http/api/transport.go 71.42% <100.00%> (ø)
things/api/auth/http/transport.go 91.78% <100.00%> (ø)
twins/api/http/transport.go 90.62% <100.00%> (ø)
ws/api/endpoints.go 76.34% <100.00%> (ø)
... and 1 more

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Copy link
Member

@rodneyosodo rodneyosodo left a comment

Choose a reason for hiding this comment

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

ws/api/transport.go Show resolved Hide resolved
bootstrap/api/transport.go Outdated Show resolved Hide resolved
twins/api/http/transport.go Outdated Show resolved Hide resolved
Copy link
Collaborator

@dborovcanin dborovcanin left a comment

Choose a reason for hiding this comment

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

Looks good, please resolve the remarks left b y @rodneyosodo.

api/openapi/websocket.yml Outdated Show resolved Hide resolved
api/asyncapi/websocket.yml Outdated Show resolved Hide resolved
api/asyncapi/websocket.yml Show resolved Hide resolved
@ianmuchyri
Copy link
Contributor Author

I've made the necessary changes requested.

Copy link
Member

@rodneyosodo rodneyosodo left a comment

Choose a reason for hiding this comment

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

I am still getting errors on api/asyncapi/websocket.yml. You can use this to check

api/asyncapi/websocket.yml Outdated Show resolved Hide resolved
api/asyncapi/websocket.yml Outdated Show resolved Hide resolved
api/asyncapi/websocket.yml Show resolved Hide resolved
Copy link
Member

@rodneyosodo rodneyosodo left a comment

Choose a reason for hiding this comment

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

Change to api/openapi/consumers-notifiers.yml L189 example: /subscriptions/{subId}

rodneyosodo
rodneyosodo previously approved these changes Apr 14, 2023
auth/api/http/keys/transport.go Outdated Show resolved Hide resolved
api/asyncapi/mqtt.yml Show resolved Hide resolved
api/asyncapi/mqtt.yml Outdated Show resolved Hide resolved
api/asyncapi/mqtt.yml Show resolved Hide resolved
api/asyncapi/mqtt.yml Show resolved Hide resolved
@drasko
Copy link
Contributor

drasko commented Apr 17, 2023

@ianmuchyri fix DCO please: https://github.com/mainflux/mainflux/pull/1762/checks?check_run_id=12804057646

Signed-off-by: ianmuchyri <ianmuchiri8@gmail.com>
improve path parameter naming for:
   bootstrap/api/transport.go
   twins/api/http/transport.go

Signed-off-by: ianmuchyri <ianmuchiri8@gmail.com>
Duplicated the functions decodeView and decodeListByConnection to
form new functions decodeThingView, decodeChannelView,
decodeThingListByConnection and decodeChannelListByConnection. This
was as a result of the two functions being used for both view thing
and view channel services

Signed-off-by: ianmuchyri <ianmuchiri8@gmail.com>
Improve path parameter naming for:
    auth/api/http/groups/transport.go
    bootstrap/api/transport.go
    twins/api/http/transport.go
    ws/api/endpoints.go

Signed-off-by: ianmuchyri <ianmuchiri8@gmail.com>
Updated the following swagger files
    api/openapi/auth.yml
    api/openapi/cert.yml
    api/openapi/websocket.yml

Signed-off-by: ianmuchyri <ianmuchiri8@gmail.com>
ianmuchyri and others added 9 commits April 17, 2023 17:56
deleted websocket.yml file in openapi and created websocket.yml file
in asyncapi

Signed-off-by: ianmuchyri <ianmuchiri8@gmail.com>
Update the websocket.yml file to make subtopic optional and
added security (bearerAuth)

Signed-off-by: ianmuchyri <ianmuchiri8@gmail.com>
format newline for api/asyncapi/websocket.yml

Signed-off-by: ianmuchyri <ianmuchiri8@gmail.com>
update the websocket.yml file based on the requested review changes
    The document is now valid

Signed-off-by: ianmuchyri <ianmuchiri8@gmail.com>
make changes to path parameter naming in:
    api/openapi/consumers-notifiers.yml

Signed-off-by: ianmuchyri <ianmuchiri8@gmail.com>
Update path parameters naming to be consistent with Go

Signed-off-by: ianmuchyri <ianmuchiri8@gmail.com>
update the mqtt.yml file to the latest AsyncAPI version and
make changes on the security of the server

Signed-off-by: ianmuchyri <ianmuchiri8@gmail.com>
Signed-off-by: ianmuchyri <ianmuchiri8@gmail.com>
Co-authored-by: b1ackd0t <blackd0t@protonmail.com>
Signed-off-by: ianmuchyri <ianmuchiri8@gmail.com>
things/api/things/http/transport.go Show resolved Hide resolved
ws/api/transport.go Show resolved Hide resolved
Signed-off-by: ianmuchyri <ianmuchiri8@gmail.com>
Copy link
Contributor

@drasko drasko left a comment

Choose a reason for hiding this comment

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

LGTM

@drasko drasko merged commit 7948aa7 into absmach:master Apr 20, 2023
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.

Improve path parameters naming
5 participants