Skip to content

fix(privatenetworks): PrivateNetworksDomainsList must take a pagination.Request in argument #486

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.

Sign up for GitHub

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

Merged
EtienneM merged 1 commit into from
Mar 11, 2026
Merged

fix(privatenetworks): PrivateNetworksDomainsList must take a pagination.Request in argument #486

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

## To Be Released

* fix(privatenetworks): `PrivateNetworksDomainsList` must take a `pagination.Request` in argument (breaking change)

## 10.0.0

* chore(databases): refactor constants
Expand Down
25 changes: 8 additions & 17 deletions privatenetworks.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,13 @@ package scalingo

import (
"context"
"net/http"
"net/url"
"strconv"

httpclient "github.com/Scalingo/go-scalingo/v10/http"
"github.com/Scalingo/go-utils/errors/v3"
"github.com/Scalingo/go-utils/pagination"
)

type PrivateNetworksService interface {
PrivateNetworksDomainsList(ctx context.Context, app string, page uint, perPage uint) (pagination.Paginated[[]PrivateNetworkDomain], error)
PrivateNetworksDomainsList(ctx context.Context, app string, paginationReq pagination.Request) (pagination.Paginated[[]PrivateNetworkDomain], error)
}

var _ PrivateNetworksService = (*Client)(nil)
Expand All @@ -23,28 +19,23 @@ type PrivateNetworkDomainsRes struct {
Domains pagination.Paginated[[]PrivateNetworkDomain] `json:"domain_names"`
}

func (c *Client) PrivateNetworksDomainsList(ctx context.Context, app string, page uint, perPage uint) (pagination.Paginated[[]PrivateNetworkDomain], error) {
var err error
func (c *Client) PrivateNetworksDomainsList(ctx context.Context, app string, paginationReq pagination.Request) (pagination.Paginated[[]PrivateNetworkDomain], error) {
validationErr := errors.NewValidationErrorsBuilder()
if page < 1 {
if paginationReq.Page < 1 {
validationErr.Set("page", "must be greater than zero")
return pagination.Paginated[[]PrivateNetworkDomain]{}, validationErr.Build()
}

if perPage < 1 || perPage > 50 {
if paginationReq.PerPage < 1 || paginationReq.PerPage > 50 {
validationErr.Set("per_page", "must be between 1 and 50")
return pagination.Paginated[[]PrivateNetworkDomain]{}, validationErr.Build()
}

params := url.Values{}
params.Set("page", strconv.Itoa(int(page)))
params.Set("per-page", strconv.Itoa(int(perPage)))
req := &httpclient.APIRequest{
Method: http.MethodGet,
Endpoint: "/apps/" + app + "/private_network_domain_names?" + params.Encode(),
}
var domainRes PrivateNetworkDomainsRes
err = c.ScalingoAPI().DoRequest(ctx, req, &domainRes)
Copy link
Copy Markdown
Member Author

@EtienneM EtienneM Mar 11, 2026

Choose a reason for hiding this comment

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

We should not use DoRequest if the use of the functions in the http.Client interface are possible. Here we can easily use SubresourceList.

err := c.ScalingoAPI().SubresourceList(ctx,
"apps", app, "private_network_domain_names", paginationReq.ToURLValues(),
&domainRes,
)
if err != nil {
return pagination.Paginated[[]PrivateNetworkDomain]{}, errors.Wrap(ctx, err, "make api call to list the private network domain names")
}
Expand Down