chore: refactor list params to include 'limit' (#101)

Author: shwetha-manvinkurke

README.md

@@ -328,14 +328,14 @@ func main() {
 	params := &openapi.ListMessageParams{}
 	params.SetFrom(from)
 	params.SetPageSize(20)
-	limit := 100
+	params.SetLimit(100)
 
-	resp, _ := client.ApiV2010.ListMessage(params, limit)
+	resp, _ := client.ApiV2010.ListMessage(params)
 	for record := range resp {
 		fmt.Println("Body: ", *resp[record].Body)
 	}
 
-	channel, _ := client.ApiV2010.StreamMessage(params, limit)
+	channel, _ := client.ApiV2010.StreamMessage(params)
 	for record := range channel {
 		fmt.Println("Body: ", *record.Body)
 	}

client/page_util.go

@@ -10,25 +10,25 @@ import (
 )
 
 //Takes a limit on the max number of records to read and a max pageSize and calculates the max number of pages to read.
-func ReadLimits(pageSize *int, limit int) int {
+func ReadLimits(pageSize *int, limit *int) int {
 	//don't care about pageSize
 	if pageSize == nil {
-		if limit == 0 {
+		if limit == nil {
 			//don't care about the limit either
 			return 50 //default
 		}
 		//return the most efficient pageSize
-		return min(limit, 1000)
+		return min(*limit, 1000)
 	} else {
-		if limit == 0 {
+		if limit == nil {
 			//we care about the pageSize but not the limit
 			return *pageSize
 		}
-		return min(*pageSize, limit)
+		return min(*pageSize, *limit)
 	}
 }
 
-func GetNext(response interface{}, curRecord *int, limit int, getNextPage func(nextPageUri string) (interface{}, error)) (interface{}, error) {
+func GetNext(response interface{}, curRecord *int, limit *int, getNextPage func(nextPageUri string) (interface{}, error)) (interface{}, error) {
 	nextPageUri, err := getNextPageUri(response, curRecord, limit)
 	if err != nil {
 		return nil, err
@@ -72,7 +72,7 @@ func toMap(s interface{}) map[string]interface{} {
 	return payload
 }
 
-func getNextPageUri(response interface{}, curRecord *int, limit int) (string, error) {
+func getNextPageUri(response interface{}, curRecord *int, limit *int) (string, error) {
 	//get just the non metadata info and the next page uri
 	payload, nextPageUri, err := GetPayload(response)
 	if err != nil {
@@ -81,13 +81,13 @@ func getNextPageUri(response interface{}, curRecord *int, limit int) (string, er
 
 	*curRecord += len(payload)
 
-	if limit != 0 {
+	if limit != nil {
 		//we have reached the desired limit
-		if limit <= *curRecord {
+		if *limit <= *curRecord {
 			return "", nil
 		}
 
-		remaining := limit - *curRecord
+		remaining := *limit - *curRecord
 		if remaining > 0 {
 			pageSize := min(len(payload), remaining)
 			re := regexp.MustCompile(`PageSize=\d+`)

client/page_util_test.go

@@ -7,11 +7,15 @@ import (
 )
 
 func TestReadLimits(t *testing.T) {
-	assert.Equal(t, 5, ReadLimits(nil, 5))
-	assert.Equal(t, 5, ReadLimits(setPageSize(10), 5))
-	assert.Equal(t, 1000, ReadLimits(nil, 5000))
-	assert.Equal(t, 10, ReadLimits(setPageSize(10), 0))
-	assert.Equal(t, 50, ReadLimits(nil, 0))
+	assert.Equal(t, 5, ReadLimits(nil, setLimit(5)))
+	assert.Equal(t, 5, ReadLimits(setPageSize(10), setLimit(5)))
+	assert.Equal(t, 1000, ReadLimits(nil, setLimit(5000)))
+	assert.Equal(t, 10, ReadLimits(setPageSize(10), nil))
+	assert.Equal(t, 50, ReadLimits(nil, nil))
+}
+
+func setLimit(limit int) *int {
+	return &limit
 }
 
 func setPageSize(pageSize int) *int {

go.mod

@@ -8,5 +8,6 @@ require (
 	github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e // indirect
 	github.com/pkg/errors v0.9.1
 	github.com/stretchr/testify v1.7.0
+	golang.org/x/tools v0.1.5 // indirect
 	gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f // indirect
 )

go.sum

@@ -15,6 +15,33 @@ github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZN
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/yuin/goldmark v1.3.5/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k=
+golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
+golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
+golang.org/x/mod v0.4.2 h1:Gz96sIWK3OalVv/I/qNygP42zyoKp3xptRVCWRFEBvo=
+golang.org/x/mod v0.4.2/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
+golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
+golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
+golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4/go.mod h1:p54w0d4576C0XHj96bSt6lcn1PtDYWL6XObtHCRCNQM=
+golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210510120138-977fb7262007 h1:gG67DSER+11cZvqIMb8S8bt0vZtiN6xWYARwirrOSfE=
+golang.org/x/sys v0.0.0-20210510120138-977fb7262007/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
+golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
+golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
+golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
+golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
+golang.org/x/tools v0.1.5 h1:ouewzE6p+/VEB31YYnTbEJdi8pFqKp4P4n85vwo3DHA=
+golang.org/x/tools v0.1.5/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk=
+golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 h1:go1bK/D/BFZV2I8cIQd1NKEZ+0owSTG1fDTci4IqFcE=
+golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f h1:BLraFXnmrev5lT+xlilqcH8XK9/i0At2xKjWk4p6zsU=
 gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=

rest/accounts/v1/credentials_aws.go

@@ -157,6 +157,7 @@ Other parameters are passed through a pointer to a ListCredentialAwsParams struc
 Name | Type | Description
 ------------- | ------------- | -------------
 **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
+**Limit** | **int** | Max number of records to return.
 
 ### Return type
 

rest/accounts/v1/credentials_public_keys.go

@@ -157,6 +157,7 @@ Other parameters are passed through a pointer to a ListCredentialPublicKeyParams
 Name | Type | Description
 ------------- | ------------- | -------------
 **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
+**Limit** | **int** | Max number of records to return.
 
 ### Return type