ListAlertsForOrg options should support cursor pagination

[jporzucek]

At the moment ListAlertsForOrg function supports only offset (page) pagination while querying REST API https://api.github.com/orgs/ORG/code-scanning/alerts endpoint returns link header with after query parameter. Therefore, the AlertListOptions struct should include ListCursorOptions field.

[gmlewis]

According to the docs here: https://docs.github.com/en/rest/code-scanning#list-code-scanning-alerts-for-an-organization
These endpoints also take a page parameter that it an integer, which is what ListOptions provides.

So unfortunately, this is not a simple replacement, and #2512 would be a breaking API change that would confuse anybody currently using the Page field.

This is going to need some discussion as how to correctly solve this situation.
My initial thought is that we need a third type of ListCursorOptions where Page is an int instead of a string, but am open to other ideas.

[jporzucek]

But at the same time docs says that both pages and cursors are allowed so isn't ListCursorOptions a natural candidate here? From what I'm seeing ListCursorOptions just extends ListOptions for cursors support.

[edit] I see now, there is string and int difference for page 😞

[jporzucek]

Did some digging and looks like that the only endpoint in the whole API that accepts page parameter as string is https://docs.github.com/en/enterprise-cloud@latest/rest/teams/team-sync#list-idp-groups-for-an-organization and what's more, it doesn't define a page number but page token (whatever it is).

Therefore, it may make sense to create a new type of ListOptions specifically for that edge case.

Also, page as string is now confusing for all endpoints that accept it as int and use ListCursorOptions type.

[gmlewis]

Yikes! That is a bit disturbing, @jporzucek - thank you for the research!

Would you mind contacting GitHub tech support and explaining the situation to them and see if they have a recommendation for us here in this repo? Feel free to point to this issue that you started.

[AbbanMustafa]

This seems to be a consistent issue across GitHub's API. I had just recently resolved this issue for Secret Scan Alerts #2446

[gmlewis]

This seems to be a consistent issue across GitHub's API. I had just recently resolved this issue for Secret Scan Alerts #2446

Ah, right... thank you for the reminder, @AbbanMustafa !
So we are fine with pulling in both types of list options into the struct where it is necessary.

@jporzucek - could you please do something similar to #2446 ?

[jporzucek]

I brought back ListOptions field as suggested together with a test case.

I'm also in touch with GitHub Support so we're sure what type of pagination is indeed supported on that endpoint. Will let you know here once I got a final response.