Skip to content

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

Open
@BenedictStrunk-otto

Description

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 :)

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions