[Schema Inaccuracy] /orgs/{org}/dependabot/alerts schema is missing 'page'
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 68/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- openapi
- Domain
- api
Research direction
Start by locating the OpenAPI schema for GET /orgs/{org}/dependabot/alerts and compare its parameters with the linked Dependabot documentation and other organizational alert endpoints. Add the missing page parameter and verify that the schema matches the endpoint’s pagination links and supports generated clients using page.
Written by the indexing model from the issue text.
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.
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
- Call Endpoint
- 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 :)
- Dominant language
- No language data
- Stars
- 1.6k
- Forks
- 342
- Avg merge
- 2h 23m
- Merged PRs (30d)
- 57
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from github/rest-api-description
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
github/rest-api-description#7220 ·
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
github/rest-api-description#7201 ·
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
github/rest-api-description#7163 ·
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
github/rest-api-description#7162 ·
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
github/rest-api-description#7135 ·
All issues in github/rest-api-description
Similar issues
-
Area: Excel support
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
orbeon/orbeon-forms#7893 ·
-
essnmx good first issue
Difficulty 1/5 Under an hour Newbie friendliness 95/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
yeti-platform/yeti#1380 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
modelcontextprotocol/python-sdk#3566 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
griptape-ai/griptape#2353 ·