Skip to content

Commit 26f8c2e

Browse files
scaleway-botyfodil
andauthored
feat(vpc/v2): add ListSubnets docs (#2085)
Co-authored-by: Yacine Fodil <[email protected]>
1 parent 79c74e4 commit 26f8c2e

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

api/vpc/v2/vpc_sdk.go

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -555,19 +555,26 @@ type ListSubnetsRequest struct {
555555
// Region: region to target. If none is passed will use default region from the config.
556556
Region scw.Region `json:"-"`
557557

558-
// OrderBy: default value: created_at_asc
558+
// OrderBy: sort order of the returned subnets.
559+
// Default value: created_at_asc
559560
OrderBy ListSubnetsRequestOrderBy `json:"-"`
560561

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

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

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

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

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

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

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

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

0 commit comments

Comments
 (0)