List* methods should not be paginated by default; create paginated versions

[theckman]

In v1 of the API we do not disambiguate between methods that do the pagination for us, and those that do it on our behalf. A good example is ListBusinessServices().

For v2 we should probably update ListBusinessServices() to not automatically do pagination, and create a ListBusinessServicesPaginated() version instead.

We should probably adopt this naming scheme in v1 for anything that we add that is going to do pagination on the behalf of the user. One example of us already doing this:

go-pagerduty/service.go

Line 125 in 1a0c44e

func (c *Client) ListServicesPaginated(ctx context.Context, o ListServiceOptions) ([]Service, error) {

[theckman]

Others to fix:

go-pagerduty/ruleset.go

Lines 142 to 154 in 77a73c9

	// ListRulesets gets all rulesets. This method currently handles pagination of
	// the response, so all rulesets should be present.
	//
	// Please note that the automatic pagination will be removed in v2 of this
	// package, so it's recommended to use ListRulesetsPaginated instead.
	func (c *Client) ListRulesets() (*ListRulesetsResponse, error) {
	rs, err := c.ListRulesetsPaginated(context.Background())
	if err != nil {
	return nil, err
	}
	return &ListRulesetsResponse{Rulesets: rs}, nil
	}

go-pagerduty/ruleset.go

Lines 265 to 278 in 77a73c9

	// ListRulesetRules gets all rules for a ruleset. This method currently handles pagination of
	// the response, so all RuleseRule should be present.
	//
	// Please note that the automatic pagination will be removed in v2 of this
	// package, so it's recommended to use ListRulesetRulesPaginated instead.
	func (c *Client) ListRulesetRules(rulesetID string) (*ListRulesetRulesResponse, error) {
	rsr, err := c.ListRulesetRulesPaginated(context.Background(), rulesetID)
	if err != nil {
	return nil, err
	}
	return &ListRulesetRulesResponse{Rules: rsr}, nil
	}

[jparram]

is there any way when using the cli to specify we want more than 25 results?

./pd service list -team-id TeamId

[andrewwatson]

is there any way when using the cli to specify we want more than 25 results?

./pd service list -team-id TeamId

No, but I did see another issue asking for that feature to be added....