Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Schema Inaccuracy] /orgs/{org}/dependabot/alerts schema is missing 'page' #4350

Open
BenedictStrunk-otto opened this issue Dec 2, 2024 · 1 comment

Comments

@BenedictStrunk-otto
Copy link

Schema Inaccuracy

The API endpoint to get dependabot alerts for an org/enterprise do not contain the page parameter.

When calling these endpoints, the returned links for rel=next etc. include the page parameter. Using the page parameter in subsequent requests works like expected, therefore the schema seems to be inconsistent with the implementation here.

https://docs.github.com/en/rest/dependabot/alerts?apiVersion=2022-11-28#list-dependabot-alerts-for-an-organization

Other Organizational Alert Endpoints (Secret Scanning etc.) have the page parameter specified in the schema.

Expected

The schema should include the page parameter for the endpoint.

Reproduction Steps

  1. Call Endpoint
  2. Response data returns links with the page set in the links section.

As I am using an lib that is auto generated from the schemas this creates issues as it tries to use a value for page on an object that does not know 'page'.

Thanks :)

@shiftkey
Copy link
Member

shiftkey commented Dec 2, 2024

👋 Thanks for the feedback. I've reached out to the team that handles this API to confirm this is the right change, and we'll follow up if there are any additional questions.

@BenedictStrunk-otto BenedictStrunk-otto changed the title /orgs/{org}/dependabot/alerts schema is missing 'page' [Schema Inaccuracy] /orgs/{org}/dependabot/alerts schema is missing 'page' Dec 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants