Skip to content

Commit

Permalink
feat(vpc/v2): add ListSubnets docs (#2085)
Browse files Browse the repository at this point in the history
Co-authored-by: Yacine Fodil <[email protected]>
  • Loading branch information
scaleway-bot and yfodil authored May 24, 2024
1 parent 79c74e4 commit 26f8c2e
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions api/vpc/v2/vpc_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -555,19 +555,26 @@ type ListSubnetsRequest struct {
// Region: region to target. If none is passed will use default region from the config.
Region scw.Region `json:"-"`

// OrderBy: default value: created_at_asc
// OrderBy: sort order of the returned subnets.
// Default value: created_at_asc
OrderBy ListSubnetsRequestOrderBy `json:"-"`

// Page: page number to return, from the paginated results.
Page *int32 `json:"-"`

// PageSize: maximum number of Private Networks to return per page.
PageSize *uint32 `json:"-"`

// OrganizationID: organization ID to filter for. Only subnets belonging to this Organization will be returned.
OrganizationID *string `json:"-"`

// ProjectID: project ID to filter for. Only subnets belonging to this Project will be returned.
ProjectID *string `json:"-"`

// SubnetIDs: subnet IDs to filter for. Only subnets matching the specified IDs will be returned.
SubnetIDs []string `json:"-"`

// VpcID: vPC ID to filter for. Only subnets belonging to this VPC will be returned.
VpcID *string `json:"-"`
}

Expand Down Expand Up @@ -1249,7 +1256,7 @@ func (s *API) EnableRouting(req *EnableRoutingRequest, opts ...scw.RequestOption
return &resp, nil
}

// ListSubnets:
// ListSubnets: List any Private Network's subnets. See ListPrivateNetworks to list a specific Private Network's subnets.
func (s *API) ListSubnets(req *ListSubnetsRequest, opts ...scw.RequestOption) (*ListSubnetsResponse, error) {
var err error

Expand Down

0 comments on commit 26f8c2e

Please sign in to comment.