Rename route: /software_updates/settings -> /settings/suma_credentials
#2264
Conversation
|
We need to temporarily skip the api bc check in the pipeline |
.github/workflows/ci.yaml
Outdated
| --json /specs/changes.json \ | ||
| --text /specs/changes.txt \ | ||
| --html /specs/changes.html | ||
| run: echo "TEMPORARY SKIP" |
There was a problem hiding this comment.
Either we remember to just edit this or I can merge with admin privileges if we all agree on that. I'd rather forcemerge instead of doing 2 PRs but up to you.
There was a problem hiding this comment.
That'd be awesome if so. I'll revert this change then.
jamie-suse
force-pushed
the
rename-suma-route
branch
from
8f5fcbd
to
16ce99f
Compare
lib/trento_web/router.ex
Outdated
| @@ -146,7 +146,7 @@ defmodule TrentoWeb.Router do | |||
|
|
|||
| get "/hosts/:id/exporters_status", PrometheusController, :exporters_status | |||
|
|
|||
| get "/software_updates/settings", SoftwareUpdatesController, :get_software_updates_settings | |||
| resources "/settings/suma_credentials", SoftwareUpdatesController, only: [:index] | |||
There was a problem hiding this comment.
I believe we might want to look at singleton-resources https://hexdocs.pm/phoenix/Phoenix.Router.html#resources/4-singleton-resources
Seems to better fit our usecase.
| resources "/settings/suma_credentials", SoftwareUpdatesController, only: [:index] | |
| resources "/settings/suma_credentials", SoftwareUpdatesController, only: [:show], singleton: true |
The operation in the controller needs adjusted to :show accordingly.
There was a problem hiding this comment.
Let's also rename the controller and file to something like SoftwareUpdatesCredentialsController or even SUMACredentialsController.
It'd be clearer which resource the actions show, update, delete would be referring to
lib/trento_web/router.ex
Outdated
| @@ -146,7 +146,7 @@ defmodule TrentoWeb.Router do | |||
|
|
|||
| get "/hosts/:id/exporters_status", PrometheusController, :exporters_status | |||
|
|
|||
| get "/software_updates/settings", SoftwareUpdatesController, :get_software_updates_settings | |||
| resources "/settings/suma_credentials", SoftwareUpdatesController, only: [:index] | |||
There was a problem hiding this comment.
Let's also rename the controller and file to something like SoftwareUpdatesCredentialsController or even SUMACredentialsController.
It'd be clearer which resource the actions show, update, delete would be referring to
Description
Renames the route at
/api/v1/software_updates/settingsto/api/v1/settings/suma_credentials.Also updates the routing code to use the
resourcesmacro to be more in-line with typical Phoenix routing code as seen in the Phoenix Routing Guide.How was this tested?
Updated existing unit tests